V7v7labs
Reports

Create a job to generate a report

Changed on

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

Request

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

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

Example request

{
  "dataset_ids": [
    123
  ],
  "filter": {
    "filters": [
      {
        "matcher": {
          "values": [
            123
          ]
        }
      }
    ]
  },
  "start": "2020-01-20T14:00:00Z",
  "stop": "2020-01-20T14:00:00Z",
  "user_ids": [
    123
  ]
}

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' | 'storage' 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"
}

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

    • warning

      added the new storage enum value to the response property for the response status

    • info

      added the new reject_reasons enum value to the request property /