---
title: "Get brand maps"
method: GET
path: "/api/v1/discovery/brand-maps/{id}"
tags: ["discovery"]
deprecated: true
---

# Get brand maps

`GET /api/v1/discovery/brand-maps/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/brand-maps/{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`)

> **Deprecated.**

Deprecated: use discovery.brand-maps.get.v2 (discovery_brand_maps_get_v2), which answers the results window the map reads in `scope.window` and carries no arc verdict; this version draws the same map, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, and reads every arc's `confident` as false. Read a campaign's brand map: the brands ranked by head-to-head strength, their pairwise records, and the default ring. Brand icons are read with discovery.brand-icons.get.

## 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.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- DiscoveryBrandMapsGetResponse
  - `scope` DiscoveryScope2, required
    - `campaignId` string, required
    - `state` 'ready' | 'running' | 'failed' | 'out-of-range' | 'no-campaign', required: `ready` carries results; every other state carries none.
    - `dispatchId` string, nullable, required: The newest run that measured a conversation of the results window's as-of window.
    - `failureReason` string, nullable, required
    - `perspective` object, nullable, required: The brand lens applied; null when the report honors no lens or carries no results.
      - `brand` string, required: The brand the results were read as.
      - `isOwnBrand` boolean, required: Whether that brand is the campaign's own.
  - `map` object, nullable, required: Null unless `scope.state` is `ready`.
    - `datasetKey` string, required
    - `ladder` object[], required: The brand picker's universe: evidence-gated brands in strength order, then below-gate brands with a decided matchup.
      - `key` string, required
      - `name` string, required
      - `rank` number, required: 1-based circle position by graded head-to-head strength.
      - `isTarget` boolean, required: True for the campaign's own brand.
      - `kind` 'competitor' | 'hybrid', nullable: How the rival competes; null for the campaign's own brand or when unclassified.
      - `relationshipTypeCounts` object: Every label beside the rival's kind, with how often it was given.
      - `pairWins` number
      - `pairLosses` number
      - `dominance` number
    - `edges` object[], required
      - `source` string, required: The matchup's overall winner.
      - `target` string, required
      - `wins` number, required
      - `losses` number, required
      - `total` number, required
      - `confident` boolean, required: The Wilson 95% lower bound of the winner's share exceeds 50%.
    - `defaultRing` string[]: The ring's priority after the center: before any hand-pick the canvas draws the center, then these brand keys the center has met, then its other opponents, to the cap.
    - `summary` object
      - `totalBrandCount` number, required
      - `targetDecidedMatchupTotal` number, required
    - `brandNames` string[], required: The brand names whose favicons `discovery.brand-icons.get.v2` reads for this map.

## 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)