Skip to main content
GET
Get goal insights

Authorizations

Authorization
string
header
required

A Nemonist key (sk-nm-...) as a bearer token in the Authorization header.

Path Parameters

id
string
required

The folder's id (fld_...), as GET /folders lists it.

Query Parameters

q
string

The Goals filter, as GET /issues.

period
enum<string>
default:2W

How many days back.

Available options:
2W,
1M,
3M,
max

Response

The burn up.

Days, two series and today's groups.

period
string
required

2W, 1M, 3M or max (max: from the oldest goal's day, at most 3660 days).

days
string[]
required

Each UTC day of the period, oldest first.

YYYY-MM-DD.

series
object[]
required

Open, then Closed: one count per day.

groups
object
required

Today's counts.

total
integer
required

Goals the filter matched.

undated
integer
required

Of those, goals with no opened time (not drawn).

complete
boolean
required

false when a goal dropped its oldest closes.

q
string

The filter, when one was given.