Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Reports

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
post/api/v3/teams/{team_slug}/reports/jobs

Path parameters

team_slugstring required

Team's sluggified name

Request body

dataset_idsCommonIntegerId[] nullable
format'csv' | 'json'

Report format.

group_byReportGroupBy[] required

Types of grouping.

metricsReportJobRequestMetricsItem[] required

Job request metrics.

startstring date-time required

DateTime in RFC3339 format

stopstring date-time required

DateTime in RFC3339 format

type'annotator' | 'item'

Report type.

user_idsCommonIntegerId[] nullable

Response

Report.JobResponse

format'csv' | 'json' required

Report format.

idstring required
inserted_atstring date-time required

DateTime in RFC3339 format

owner_idinteger nullable
status'pending' | 'running' | 'finished' | 'failed' required
team_idinteger required
type'annotator' | 'item' required
updated_atstring date-time required

DateTime in RFC3339 format

urlstring nullable required

Example response

{
  "inserted_at": "2020-01-20T14:00:00Z",
  "team_id": 123,
  "updated_at": "2020-01-20T14:00:00Z"
}