Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Query

    competitorBrands

    List Competitor Insights brands tracked by the current workspace, newest first. Each brand carries aggregate metrics over a period/date window (default month). The first page also returns the workspace's own brand as one pinned node, flagged isOwnBrand. It comes in addition to up to first competitor brands, so one query gives self-vs-competitor Share of Voice. totalCount counts tracked competitor brands only. Pair with competitorBrandItems(brandId:, filter:, …) to paginate a brand's media items. When aggregate metrics are unavailable, the roster data still returns, with a SERVICE_UNAVAILABLE error. Match on extensions.code and retry later.

    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.

    after String default null
    Cursor for fetching the next page of results.
    date DateWithZone default null
    Anchor date (e.g. 2025-06-01) for the aggregation window. Defaults to the latest month whose data is complete (for WEEK, the latest complete week). A date whose window ends after the latest selectable day is moved back to the latest complete window, not rejected.
    first Int default 20
    Number of competitor brands to return (page size). The own-brand entry is additional.
    includeProvisionalDays Boolean default false
    Requires postDate. Explicitly acknowledge that engagement figures may still grow and allow the window through the latest day Competitor Insights lets the workspace select, including Early-access days. Omitted, null or false uses the latest settled day. A workspace without Early access gains no additional days. Out-of-bounds windows are rejected, not shortened.
    period CompetitorBrandStatsPeriod default MONTH
    Aggregation window for the metric fields (WEEK or MONTH). Defaults to MONTH.
    postDate FilterDateRangeInput default null
    Inclusive post-date window in whole UTC days, an alternative to period and date. Both bounds are required. It must lie within Competitor Insights data through the latest settled UTC day (currently today minus 8 days) and span at most 3 months. Out-of-bounds windows are rejected, not shortened. The previous period covers as many whole months before it when it spans whole months. Otherwise it is the equal-length window before it. A previous period that starts before Competitor Insights data is cut to start on that date, so read its from. Passing period or date with it returns an INVALID_INPUT error.

    Returns

    A paginated connection of CompetitorBrand nodes. See Pagination for the connection shape.

    edges [CompetitorBrandEdge!]!
    List of edges with cursors.
    nodes [CompetitorBrand!]!
    List of competitor brands.
    pageInfo PageInfo!
    Pagination information.
    totalCount Int
    Total number of competitor brands tracked by the workspace. The pinned own-brand entry (isOwnBrand: true) is not counted, so the first page returns totalCount + 1 nodes when every competitor fits on it.