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

    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

    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.

    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 .

    earnedMediaValue Float
    Estimated earned media value (USD) over the window. Null when unavailable or no data.
    engagementsTotal Float
    Total engagements (likes + comments + shares, …) over the window. Null when unavailable or no data.
    id ID!
    Unique identifier for the brand in Archive's system. For the workspace's own-brand entry this is a stable, workspace-scoped id (the same across requests).
    impressions Float
    Merged view/play impressions over the window. Null when unavailable or no data.
    influencersCount Int
    Distinct influencers counted over the window. Null when unavailable or no data.
    isOwnBrand Boolean!
    True for the workspace's own-brand entry, false for tracked competitor brands. Use this to compute self-vs-competitor Share of Voice.
    name String!
    Brand name. The workspace's own-brand entry is named "You".
    ownMetricsStatus CompetitorBrandOwnMetricsStatus
    For the own-brand entry only (null for competitors): AVAILABLE when metrics were computed (null metric fields then mean no data in the window, distinct from zero), UNAVAILABLE when they could not be computed. The accompanying error code says whether to retry.
    postsCount Int
    Number of posts counted over the window. Null when unavailable or no data.
    reach Float
    Summed follower reach over the window. Null when unavailable or no data.