V7v7labs
Reports

Annotators report for datasets

Changed on

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

Request

  • Base URL
    https://darwin.v7labs.com
  • URL
    https://darwin.v7labs.com/api/v3/teams/{team_slug}/reports/annotator
  • Auth
    • HTTP bearer
    • or API key in header Authorization

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
stopstring date-time required

DateTime in RFC3339 format

Example:2020-01-20T14:00:00Z
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"
    }
  ]
}

Changes

  • 9cd7289ca12bRevision changes
    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new DUPLICATE_REJECT_REASON enum value to the // response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the / response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the / response property for the response status

    • warning

      added the new EXTERNAL_STORAGE_ACCESS_FAILED enum value to the // response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASON enum value to the // response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new INVALID_REJECT_REASONS enum value to the // response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the / response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the / response property for the response status

    • warning

      added the new REJECT_REASON_REQUIRED enum value to the // response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the / response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the / response property for the response status

    • warning

      added the new REPORT_TOO_LARGE enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_ACTIVE_REPORT_JOBS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_AI_REVIEW_BLUEPRINTS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_PENDING_EXPORTS enum value to the // response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the / response property for the response status

    • warning

      added the new TOO_MANY_REJECT_REASONS enum value to the // response property for the response status

    • info

      added the enum value reject_reasons to the property oneOf[Report.AnnotatorMetricsContainer]/oneOf[subschema #1: Report.AnnotatorMetrics]/items/ of the query request parameter metrics[]

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status