Create a job to generate a report

Starts a background job to generate an 'annotator' or 'item' report.
Immediately returns job info, containing the file URL to get the report from.

Note:

  • The 'annotator' report data is available from 2024-11-05
  • The 'item' report data is available from 2025-08-01
  • All times are UTC. Every row of the report file has period_start and period_end (ISO 8601, end exclusive): the range the report covers, which is start raised to the date above for its type and stop capped at the time the job ran. They are the last two CSV columns. timestamp is a deprecated alias of period_start.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Team's sluggified name

Body Params

Report.JobRequest

Job request information.

dataset_ids
array of objects | null
Defaults to []
Common.IntegerIds
string
enum
Defaults to json

Report format.

Allowed:
group_by
array of objects
required

Types of grouping.

Report.GroupBys*
Allowed:
metrics
array of objects
required

Job request metrics.

Report.JobRequestMetrics*
date-time
required

DateTime in RFC3339 format

date-time
required

DateTime in RFC3339 format

string
enum
Defaults to annotator

Report type.

Allowed:
user_ids
array of objects | null
Defaults to []
Common.IntegerIds
Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json