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

# Get market maps

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

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/market-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.market-maps.get.v2 (discovery_market_maps_get_v2), which answers the results window the map reads in `scope.window`; this version draws the same map and names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days. Read a campaign's market map: the market's layers and the brands and entities seated in each, as the run's relationship analysis classified them.

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

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- DiscoveryMarketMapsGetResponse
  - `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` DiscoveryMap, nullable, required: Null unless `scope.state` is `ready`.
    - `datasetKey` string, required
    - `targetBrandName` string, nullable, required
    - `artifact` object, nullable, required: The market ontology as written; null when the campaign has none.
      - `version` 1, required
      - `market_summary` string, required
      - `strata` object[], required
        - `id` string, required
        - `label` string, required
        - `order` integer, required
      - `roles` object[], required
        - `id` string, required
        - `label` string, required
        - `stratum` string, required
        - `tier` 'core' | 'detail', required
        - `inferred` boolean, required
        - `description` string, required
      - `label_map` object[], required
        - `canonical_label` string, required
        - `role_id` string, required
      - `edges` object[], required
        - `source_role_id` string, required
        - `predicate` 'sells_to' | 'contracts_with' | 'distributes_through' | 'supplies' | 'regulates' | 'competes_with', required
        - `target_role_id` string, required
      - `customer_anchor_role_id` string, required
    - `absence` 'in_progress' | 'next_daily_run' | 'none', nullable, required: Why there is no map; null when `artifact` is set. `in_progress`: the first run writes it; `next_daily_run`: the next daily run writes it; `none`: nothing will.
    - `brandClusters` object[], required
      - `roleId` string, required
      - `brands` object[], required
        - `name` string, required
        - `isTargetBrand` boolean, required
        - `source` 'observed' | 'profile', required
        - `mentions` number: The as-of window's conversations where an answer brought the brand up.
    - `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)