QUERY

competitorBrand

Return a single Competitor Insights brand by ID for the current workspace, or null if no brand with that ID is tracked here. Also resolves the workspace's own-brand entry by its stable id. Pair with competitorBrandItems(brandId:, filter:, …) to paginate the brand's media items. If aggregate metrics are unavailable, roster data remains and the response includes a SERVICE_UNAVAILABLE error; match on extensions.code and retry later.

MCP: getCompetitorBrand

Arguments

date DateWithZone default: null: Anchor date (e.g. 2025-06-01) for the aggregation window. Defaults to today.
id ID! required: Competitor Insights brand ID. Also resolves the workspace's own-brand entry by its stable id.
period CompetitorBrandStatsPeriod default: MONTH: Aggregation window for the metric fields (WEEK or MONTH). Defaults to MONTH.

Returns

Returns CompetitorBrand .

Open in explorer ↗

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

Fetch a single tracked Competitor Insights brand by ID.

query.graphql

query CompetitorBrandDefault($id: ID!) {
  competitorBrand(id: $id) {
    id
    name
  }
}

variables.json

{
  "id": "28add94e-9994-54b2-9aaa-528e6606efe9"
}

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 CompetitorBrandDefault($id: ID!) {\n  competitorBrand(id: $id) {\n    id\n    name\n  }\n}",
  "variables": {
    "id": "28add94e-9994-54b2-9aaa-528e6606efe9"
  }
}'

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 CompetitorBrandDefault($id: ID!) {
  competitorBrand(id: $id) {
    id
    name
  }
}`,
    variables: {
      "id": "28add94e-9994-54b2-9aaa-528e6606efe9"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  query CompetitorBrandDefault($id: ID!) {
    competitorBrand(id: $id) {
      id
      name
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "28add94e-9994-54b2-9aaa-528e6606efe9" } }.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 CompetitorBrandDefault($id: ID!) {
  competitorBrand(id: $id) {
    id
    name
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"id": "28add94e-9994-54b2-9aaa-528e6606efe9"}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "competitorBrand": {
      "id": "28add94e-9994-54b2-9aaa-528e6606efe9",
      "name": "Verdant Co."
    }
  }
}