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 details for an operation by ID, including 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.
    id ID!
    Unique identifier for the operation.
    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.
    total Int!
    Total number of items to process in this operation.