API ReferenceDimensions

✨ List Dimension value-counts backfill jobs

<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 Dimension value-counts backfill jobs for the authenticated user's active organization, ordered by most-recently created first. Supports page / page_size query params (default 50 per page, max 500). Requires administrator or owner role and Agreement V2 access.

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Query parameters

statusstringOptional

Filter by job status: PENDING, QUEUED, RUNNING, COMPLETED, or FAILED.

Response

created_atdatetimeRead-only
job_idintegerRead-only
Database ID of the backfill job
project_idinteger or nullRead-only

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

rq_job_idstring or nullRead-only
Redis queue job ID
triggered_bymap from strings to integers or strings or nullRead-only
User who triggered the backfill
completed_atdatetime or null
error_messagestring
Error message if job failed
progress_dataany

JSON data tracking job progress (rows_written, etc.)

started_atdatetime or null
statusenum

Current status of the backfill job

  • PENDING - Pending
  • QUEUED - Queued
  • RUNNING - Running
  • COMPLETED - Completed
  • FAILED - Failed

Errors

400
Bad Request Error
403
Forbidden Error