Sign in
Dimensions

✨ Get Agreement V2 backfill status

<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 an Agreement V2 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/backfill/status/

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

{"stackTrail":"components:schemas:AgreementV2BackfillJob:properties:progress_data","oasType":"schema","type":"unknown","description":"JSON data tracking job progress (matrices_created, errors, etc.)"}
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

Changed in 3 of the 97 revisions of this API.24

  • b5f055b9d45b2See the full diff
    • ▲

      the response property triggered_by became nullable for the status 200

      response-property-became-nullable

    • ▲

      the triggered_by response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

  • 04ff286141b52See the full diff
    • ○

      added FsmBackfillJobStatusEnum to the status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed StatusA47Enum from the status response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c2d3e4a78bf82See the full diff
    • ○

      added StatusA47Enum to the status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed AgreementV2BackfillJobStatusEnum from the status response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 97 revisions, 1 has no diff computed.