Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    operation

    Return an operation by ID, including its status and progress.

    MCP: getOperation

    Arguments

    id ID! required
    Unique identifier for the operation.

    Returns

    Returns Operation.

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    completedAt DateTimeWithZone
    Timestamp when the operation finished processing. Null if still in progress.
    createdAt DateTimeWithZone!
    Timestamp when the operation was created.
    failedCount Int!
    Number of items that failed during processing. Exact — unlike the deprecated id lists, counts never grow with operation size.
    failedItemIds [ID!]! deprecated
    IDs of items that failed during processing. Complete but unbounded — prefer operationRecords(operationId:, filter: { status: FAILED }), which returns the same population paginated. Unbounded payload — returns one id per operation record, and a UI select-all operation can hold a workspace's entire item corpus. Use succeededCount / failedCount / pendingCount for sizes and operationRecords(operationId:, filter: { status: }) for the ids, paginated. Scheduled for removal in the next API version.
    failedRecordsCsvUrl String
    For a creator import (operationType oneschema_creator_import): a download link for the CSV of the rows that failed, each with its error. Written only for a PARTIAL or FAILED import, shortly after it finishes; null before then, for a COMPLETED import, and for every other operation type. The link is valid for 1 hour: query again for a fresh one.
    id ID!
    Unique identifier for the operation.
    importSource CreatorImportSource
    For a creator import: where its rows came from. Null for other operation types and for imports that predate the field. Per-row outcomes are on operationRecords; for a creator import the deprecated succeededItemIds / failedItemIds / pendingItemIds are always empty.
    operationType String!
    The type of operation being performed (e.g., refetch_engagement).
    pendingCount Int!
    Number of items that have not finished processing (not started, in progress, or retrying). Exact — unlike the deprecated id lists, counts never grow with operation size.
    pendingItemIds [ID!]! deprecated
    IDs of items that have not yet been processed. Complete but unbounded — prefer operationRecords(operationId:, filter: { status: PENDING }), which returns the same population paginated. Unbounded payload — returns one id per operation record, and a UI select-all operation can hold a workspace's entire item corpus. Use succeededCount / failedCount / pendingCount for sizes and operationRecords(operationId:, filter: { status: }) for the ids, paginated. Scheduled for removal in the next API version.
    processed Int!
    Number of items that have been processed so far.
    status OperationStatus!
    Current processing status of the operation.
    succeededCount Int!
    Number of items that completed successfully. Exact — unlike the deprecated id lists, counts never grow with operation size.
    succeededItemIds [ID!]! deprecated
    IDs of items that completed successfully. Complete but unbounded — prefer operationRecords(operationId:, filter: { status: SUCCEEDED }), which returns the same population paginated. Unbounded payload — returns one id per operation record, and a UI select-all operation can hold a workspace's entire item corpus. Use succeededCount / failedCount / pendingCount for sizes and operationRecords(operationId:, filter: { status: }) for the ids, paginated. Scheduled for removal in the next API version.
    successfulRecordsCsvUrl String
    For a creator import (operationType oneschema_creator_import): a download link for the CSV of the rows that were imported. Written only for a PARTIAL import, shortly after it finishes; null before then, for a COMPLETED or FAILED import, and for every other operation type. The link is valid for 1 hour: query again for a fresh one.
    total Int!
    Total number of items to process in this operation.