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, ordered newest first, with aggregate metrics over a period/date window (default month). The workspace's own-brand entry is returned as one additional pinned node on the first page (flagged isOwnBrand), in addition to up to first competitor brands, so self-vs-competitor Share of Voice is computable in-query; totalCount counts tracked competitor brands only. Pair with competitorBrandItems(brandId:, filter:, …) to paginate a 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.

    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 today.
    first Int default 20
    Number of competitor brands to return (page size). The own-brand entry is additional.
    period CompetitorBrandStatsPeriod default MONTH
    Aggregation window for the metric fields (WEEK or MONTH). Defaults to MONTH.

    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 items available.