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 .

Open in explorer ↗

Values are sampled from a demo workspace — substitute your own token and workspace id.

Fetch a background operation's status and progress by ID.

query.graphql

query OperationDefault($id: ID!) {
  operation(id: $id) {
    id
    status
    operationType
    total
    processed
    succeededItemIds
    failedItemIds
    pendingItemIds
    createdAt
    completedAt
  }
}

variables.json

{
  "id": "aeb032f4-179f-549f-b83c-3db2c5b58a2d"
}

Headers

Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a' \
  -d '{
  "query": "query OperationDefault($id: ID!) {\n  operation(id: $id) {\n    id\n    status\n    operationType\n    total\n    processed\n    succeededItemIds\n    failedItemIds\n    pendingItemIds\n    createdAt\n    completedAt\n  }\n}",
  "variables": {
    "id": "aeb032f4-179f-549f-b83c-3db2c5b58a2d"
  }
}'

Request · Node.js

const response = await fetch("https://app.archive.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
  },
  body: JSON.stringify({
    query: `query OperationDefault($id: ID!) {
  operation(id: $id) {
    id
    status
    operationType
    total
    processed
    succeededItemIds
    failedItemIds
    pendingItemIds
    createdAt
    completedAt
  }
}`,
    variables: {
      "id": "aeb032f4-179f-549f-b83c-3db2c5b58a2d"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query OperationDefault($id: ID!) {
    operation(id: $id) {
      id
      status
      operationType
      total
      processed
      succeededItemIds
      failedItemIds
      pendingItemIds
      createdAt
      completedAt
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "aeb032f4-179f-549f-b83c-3db2c5b58a2d" } }.to_json,
  "Content-Type" => "application/json",
  "Authorization" => "Bearer docs_demo_token_0000000000000000000000",
  "WORKSPACE-ID" => "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
)
puts response.body

Request · Python

import json
import requests

query = """
query OperationDefault($id: ID!) {
  operation(id: $id) {
    id
    status
    operationType
    total
    processed
    succeededItemIds
    failedItemIds
    pendingItemIds
    createdAt
    completedAt
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"id": "aeb032f4-179f-549f-b83c-3db2c5b58a2d"}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "operation": {
      "id": "aeb032f4-179f-549f-b83c-3db2c5b58a2d",
      "status": "COMPLETED",
      "operationType": "refetch_engagement",
      "total": 1,
      "processed": 1,
      "succeededItemIds": [
        "3467594a-79c1-5fa4-8490-8a31646ff716"
      ],
      "failedItemIds": [],
      "pendingItemIds": [],
      "createdAt": "2024-12-31T22:00:00Z",
      "completedAt": null
    }
  }
}