pub.chive.admin.getBackfillStatus Documentation (EN)

main query

Get status of backfill operations

Parameters

id string Optional

Filter by specific operation ID

status string Optional

Filter by operation status

Output

Encodingapplication/json

operation ref#backfillOperation Optional

Single operation (when filtered by ID)

operations array Optional

Backfill operations

Errors

AuthenticationRequired

AdminRequired

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

id Filter by specific operation ID

status Filter by operation status

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {
        "operation": {
          "ref": "#backfillOperation",
          "type": "ref",
          "description": "Single operation (when filtered by ID)"
        },
        "operations": {
          "type": "array",
          "items": {
            "ref": "#backfillOperation",
            "type": "ref"
          },
          "description": "Backfill operations"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "id": {
        "type": "string",
        "description": "Filter by specific operation ID"
      },
      "status": {
        "type": "string",
        "description": "Filter by operation status",
        "knownValues": [
          "running",
          "completed",
          "failed",
          "cancelled"
        ]
      }
    }
  },
  "description": "Get status of backfill operations"
}

backfillOperation object

A backfill operation record

Properties

completedAt string datetime Optional

Operation completion time

error string Optional

Error message if failed

id string Required

Operation ID

recordsProcessed integer Required

Number of records processed so far

startedAt string datetime Required

Operation start time

startedBy string did Optional

DID of the admin who started the operation

status string Required

Operation status

Known values: running, completed, failed, cancelled

totalRecords integer Optional

Total records to process (if known)

type string Required

Backfill operation type

Known values: pds-scan, freshness-scan, citation-extraction, full-reindex, governance-sync, did-sync

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "type",
    "status",
    "startedAt",
    "recordsProcessed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Operation ID"
    },
    "type": {
      "type": "string",
      "description": "Backfill operation type",
      "knownValues": [
        "pds-scan",
        "freshness-scan",
        "citation-extraction",
        "full-reindex",
        "governance-sync",
        "did-sync"
      ]
    },
    "error": {
      "type": "string",
      "description": "Error message if failed"
    },
    "status": {
      "type": "string",
      "description": "Operation status",
      "knownValues": [
        "running",
        "completed",
        "failed",
        "cancelled"
      ]
    },
    "startedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Operation start time"
    },
    "startedBy": {
      "type": "string",
      "format": "did",
      "description": "DID of the admin who started the operation"
    },
    "completedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Operation completion time"
    },
    "totalRecords": {
      "type": "integer",
      "description": "Total records to process (if known)"
    },
    "recordsProcessed": {
      "type": "integer",
      "description": "Number of records processed so far"
    }
  },
  "description": "A backfill operation record"
}