---
title: "Get brand matchups (v2)"
method: GET
path: "/api/v1/discovery/brand-matchups-v2/{id}"
tags: ["discovery"]
---

# Get brand matchups (v2)

`GET /api/v1/discovery/brand-matchups-v2/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/brand-matchups-v2/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Read the head-to-head record between two brands in a campaign, over the conversations dated in the 30 days ending its results window's as-of day: wins, win rate, decisiveness, decided matchups, and why the loser loses, optionally within one cohort.

## Path parameters

- `id` string, uuid, required: Discovery campaign id.

## Query parameters

- `dateRange` string, nullable: Result window: `all`, a preset id, or `yyyy-MM-dd..yyyy-MM-dd`. Omit for the campaign's default window.
- `segments` string[]: Narrows the read to these segments, ANDed: one `axis:id` per axis (any number of distinct `customer:` entries), in canonical axis order. Empty reads the whole dispatch.
- `brandAKey` string, required: A brand's normalized key (trimmed, single-spaced, lowercase name).
- `brandBKey` string, required: A brand's normalized key (trimmed, single-spaced, lowercase name).
- `cohortDimension` 'decision-factors' | 'audiences' | 'engines': Reads the matchup inside one cohort; omit both cohort fields to read every conversation.
- `cohortValue` string: The cohort member's id on cohortDimension.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- DiscoveryBrandMatchupsGetV2Response
  - `data` object, required
    - `kind` 'detail', required
    - `datasetKey` string, required
    - `brandAKey` string, required
    - `brandBKey` string, required
    - `brandAWins` number, required
    - `brandBWins` number, required
    - `total` number, required
    - `brandAWinRate` number, nullable, required: 0..1; null when no matchup was decided.
    - `decisiveness` number, nullable, required: Average recommendation-strength margin per decided matchup (0..4).
    - `evidence` object, required
      - `decidedMatchups` number, required: The pair's decided matchups.
    - `loserReasons` object[], required
      - `brandKey` string, required
      - `reasons` object[], required
        - `label` string, required
        - `count` number, required
    - `availableDimensions` string[], required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)