Archive API docs

MUTATION

refetchEngagementBulk

Queue a bulk engagement data refresh for the specified items.

MCP: refetchEngagementBulk

Arguments

itemIds [ID!]! required: IDs of items to refresh engagement data for. Items belonging to other workspaces are silently ignored. Instagram stories are automatically excluded.

Returns

operationId ID: Unique identifier of the background operation created to process the refresh. Null when no items were processable (all filtered or deduplicated). Use this ID to track operation progress.
processedCount Int: Number of items accepted and queued for engagement refresh. Credits are charged only for this count.
skippedItemIds [ID!]: IDs of items skipped because they are already enqueued in another active refresh operation for this workspace. Instagram stories are silently excluded and not listed here.
userErrors [UserError!]!: Errors that prevented the mutation from executing. Common error: insufficient credits.

Open in explorer ↗

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

Queue a background job to refresh engagement metrics for the given items.

query.graphql

mutation RefetchEngagementBulkDefault($itemIds: [ID!]!) {
  refetchEngagementBulk(itemIds: $itemIds) {
    operationId
    processedCount
    skippedItemIds
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "itemIds": [
    "63c311c4-32f0-5d8c-ac02-78b160f2290a",
    "a78ec1f9-5c4b-5c8a-b3b1-e028e575b606"
  ]
}

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": "mutation RefetchEngagementBulkDefault($itemIds: [ID!]!) {\n  refetchEngagementBulk(itemIds: $itemIds) {\n    operationId\n    processedCount\n    skippedItemIds\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "itemIds": [
      "63c311c4-32f0-5d8c-ac02-78b160f2290a",
      "a78ec1f9-5c4b-5c8a-b3b1-e028e575b606"
    ]
  }
}'

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: `mutation RefetchEngagementBulkDefault($itemIds: [ID!]!) {
  refetchEngagementBulk(itemIds: $itemIds) {
    operationId
    processedCount
    skippedItemIds
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "itemIds": [
        "63c311c4-32f0-5d8c-ac02-78b160f2290a",
        "a78ec1f9-5c4b-5c8a-b3b1-e028e575b606"
      ]
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation RefetchEngagementBulkDefault($itemIds: [ID!]!) {
    refetchEngagementBulk(itemIds: $itemIds) {
      operationId
      processedCount
      skippedItemIds
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "itemIds" => ["63c311c4-32f0-5d8c-ac02-78b160f2290a", "a78ec1f9-5c4b-5c8a-b3b1-e028e575b606"] } }.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 = """
mutation RefetchEngagementBulkDefault($itemIds: [ID!]!) {
  refetchEngagementBulk(itemIds: $itemIds) {
    operationId
    processedCount
    skippedItemIds
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"itemIds": ["63c311c4-32f0-5d8c-ac02-78b160f2290a", "a78ec1f9-5c4b-5c8a-b3b1-e028e575b606"]}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "refetchEngagementBulk": {
      "operationId": "046a8f4e-686e-5773-9374-eb91cfd0c54c",
      "processedCount": 2,
      "skippedItemIds": [],
      "userErrors": []
    }
  }
}