v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB

Reports

Annotators report for datasets

Generates an annotators report for a time period

Note: the report data is available only from 2024-11-05.

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

Path parameters

team_slugstring required

Team's sluggified name

Query parameters

metrics[]ReportAnnotatorMetricItem[] required

Annotator report metrics.

user_ids[]CommonIntegerId[] nullable

[
  123
]

dataset_ids[]CommonIntegerId[] nullable

[
  123
]

startstring date-time required

DateTime in RFC3339 format

Example:2020-01-20T14:00:00Z

DateTime in RFC3339 format

stopstring date-time required

DateTime in RFC3339 format

Example:2020-01-20T14:00:00Z

DateTime in RFC3339 format

group_by[]ReportGroupBy[] required

Types of grouping.

Response

Annotator statistics report for specified filters, metrics, date range and grouping

Example response

{
  "annotator_report": [
    {
      "actor_id": 123,
      "current_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "dataset_id": 123,
      "timestamp": "2020-01-20T14:00:00Z",
      "workflow_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ],
  "annotator_report_subaggregates": [
    {
      "actor_id": 123,
      "current_stage_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "dataset_id": 123,
      "timestamp": "2020-01-20T14:00:00Z",
      "workflow_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}