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.

    Object

    CompetitorBrand

    A brand tracked in Competitor Insights for the current workspace, plus the workspace's own brand as a flagged entry (isOwnBrand: true).

    Fields

    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.

    displayName String!
    Name the Archive app shows for the brand. Same as name for competitor brands. For the own-brand entry it is the name of the brand linked as the workspace's own brand, or "You" when no brand is linked.
    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".
    ownMetricsHasData Boolean
    For the own-brand entry only: true when ownMetricsStatus is AVAILABLE and the window has own-brand data, false when it is AVAILABLE but the window has no own-brand data (every metric field is then null: treat it as missing, not zero). Null for competitor brands and when ownMetricsStatus is UNAVAILABLE.
    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.
    previousPeriod CompetitorBrandPeriodStats
    The same metrics over the window before the requested one, for period-over-period change. Null when metrics are unavailable or that window lies entirely before Competitor Insights data. A window that starts earlier is cut to start on that date, so read its from.
    provenance [CompetitorBrandMetricProvenance!]
    Captured and estimated parts of each metric total over the window. Totals can include estimates for posts Archive could not measure. Null when unavailable, when there is no data, or when the own-brand entry has no breakdown.
    reach Float
    Summed follower reach over the window. Null when unavailable or no data.