Skip to main content
GET
Get a standard's results

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

standard_mapping_id
string<uuid>
required

The unique identifier for the standard mapping.

Query Parameters

date_op
enum<string>

The period to evaluate, as the operator of a range on the mapping's period input. Relative presets (today, yesterday, last_n_days, this_week, this_month, this_quarter, this_year, and the previous full last_week, last_fortnight, last_month and last_quarter) are resolved against the Europe/London timezone when the results are read. between takes two dates, and before and after one, in date_values. Omit it for the last 30 days.

Available options:
today,
yesterday,
last_n_days,
this_week,
this_month,
this_quarter,
this_year,
last_week,
last_fortnight,
last_month,
last_quarter,
between,
before,
after
date_values
string[]

The values date_op takes, comma separated: the number of days for last_n_days, the two ends of a between, or the one date of a before or after. A date, such as 2026-11-02, or a date and time, such as 2026-11-02 09:00:00, is read in Europe/London. An RFC 3339 time, such as 2026-11-02T09:00:00Z, keeps its own offset. A between includes both ends, and a date as its upper bound covers that whole day. before a date excludes that day, and after a date starts on the day after it.

bucket
enum<string>

The length of the periods the series counts jobs in. A week starts on Monday. Omit it for weeks.

Available options:
day,
week,
month,
quarter,
year
submission_id
string<uuid>

Evaluate this one submission instead of a period. It takes no date_op, date_values or bucket.

Response

A standard's results over a period.

JSON API response object

data
object
required

A standard's results over a period, read through one standard mapping. Its id is the mapping's.

jsonapi
object
required