Dimensions

✨ Get Dimension value-counts backfill status

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Retrieve the status of a Dimension value-counts backfill job for the authenticated user's active organization. By default returns the aggregated organization status. Specify job_id or project_id to get a specific job status. Requires administrator or owner role and Agreement V2 access.
get/api/dimensions/value-counts-backfill/status/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/dimensions/value-counts-backfill/status/
  • Auth
    API key in header Authorization

Query parameters

job_idinteger

Optional job ID to retrieve specific job status

project_idinteger

Optional project ID to retrieve the latest backfill status for that project. If omitted, returns aggregated organization status.

Response

completed_atstring date-time nullable
created_atstring date-time required
error_messagestring

Error message if job failed

job_idinteger required

Database ID of the backfill job

progress_dataunknown
project_idinteger nullable required

Optional specific project to backfill (if null, backfills entire organization)

rq_job_idstring nullable required

Redis queue job ID

started_atstring date-time nullable
status'PENDING' | 'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED'
  • PENDING - Pending
  • QUEUED - Queued
  • RUNNING - Running
  • COMPLETED - Completed
  • FAILED - Failed
triggered_byobject nullable required

User who triggered the backfill

Changes

  • b5f055b9d45bRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from string to object for status

  • 04ff286141b5Revision changes
    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status