v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Reports

List all report generating jobs

Fetches the info for all existing report generating jobs.

get/api/v3/teams/{team_slug}/reports/jobs

Path parameters

team_slugstring required

Team's sluggified name

Query parameters

limitinteger nullable

The maximum number of records to return when using offset pagination

Example:50

The maximum number of records to return when using offset pagination

offsetinteger nullable

The offset to use when paginating records

Example:50

The offset to use when paginating records

type'annotator' | 'item'

Report type.

Report type.

dataset_idinteger
Example:123

Response

Report.JobList

Example response

{
  "data": [
    {
      "inserted_at": "2020-01-20T14:00:00Z",
      "team_id": 123,
      "updated_at": "2020-01-20T14:00:00Z"
    }
  ],
  "metadata": {
    "current_offset": 50,
    "page_size": 50
  }
}