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

# Get location reports

`GET /api/v1/discovery/location-reports/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/location-reports/{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.location-reports.get.v2 (discovery_location_reports_get_v2), which answers the results window it reads in `scope.window`, each place's change since 30 days before the as-of day (null without one), and no precision fields; this version reads the same, names in `scope.dispatchId` the newest run that measured a conversation of the window's last 30 days, and reads a change it cannot name as 0. Read a campaign's Locations report: its customers rolled up country → region → city → postcode, with each place's brand share, win rate, win and loss reasons, and revenue influence, under an optional brand lens and segments. Pass drivers=false or revenue=false to skip those reads.

## 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.
- `brandPerspective` string, nullable: Read the results as this brand (one of the campaign's brands). Omit for your own.
- `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.
- `drivers` boolean: Read each place's win and loss reasons. Default true; false leaves `drivers` empty.
- `revenue` boolean: Read revenue influence. Default true; it is read only under the campaign's own brand.

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- DiscoveryLocationReportsGetResponse
  - `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.
  - `report` object, nullable, required: Null unless `scope.state` is `ready`.
    - `precisionTargetMarginOfErrorPct` number
    - `panelEligibleCustomerCount` number: The unsegmented campaign-wide panel total.
    - `locations` object[], required: Places in tree order: each parent before its children.
      - `id` string, required
      - `type` 'country' | 'admin1' | 'city' | 'postcode', required
      - `name` string, required
      - `shortName` string, required
      - `color` string, required
      - `parentId` string, nullable, required
      - `childIds` string[], required
      - `level` 1 | 2 | 3 | 4, required: 1 country → 4 postcode.
      - `countryCode` string, nullable, required
      - `admin1Code` string, nullable, required
      - `city` string, nullable, required
      - `postcode` string, nullable, required
      - `map` union, required: How a map draws the place: a boundary region, a point, or not at all.
        - object
          - `mode` 'region', required
          - `regionCode` string, required
          - `resolution` 'countries' | 'provinces' | 'postal', required
        - object
          - `mode` 'marker', required
          - `latitude` number, required
          - `longitude` number, required
          - `regionCode` string
          - `resolution` 'countries' | 'provinces' | 'postal'
        - object
          - `mode` 'none', required
      - `totalConversations` number, required
      - `mentioned` number, required: Conversations that mentioned the brand.
      - `won` number, required: Conversations the brand won.
      - `brandShare` number, required
      - `winRate` number, required
      - `vsPortfolioPts` number, required: Brand win rate minus the campaign's all-up brand win rate, in points.
      - `topCompetitor` string, nullable
      - `isHomeBase` boolean
      - `geoRegion` string, nullable
      - `geoResolution` 'countries' | 'provinces' | 'postal', nullable
      - `revenueInfluencedUsd` number, nullable: Target revenue influenced; null when revenue was not read.
      - `eligibleCustomerCount` number
      - `brandShareDelta` number, required
      - `winRateDelta` number, required
      - `revenueEligibleCustomerCount` number
    - `drivers` object[], required
      - `locationId` string, required
      - `kind` 'win' | 'loss', required
      - `label` string, required: The reason, as the model wrote it.
      - `count` number, required: Conversations citing the reason.
      - `eligibleCustomerCount` number
      - `series` object[]
        - `month` string, required
        - `value` number, required
    - `conversationCount` number, required
    - `portfolioShare` number, required
    - `portfolioWinRate` number, required
    - `revenueCoverage` object, required
      - `scope` 'locations': Location estimates may overlap markets.
      - `status` 'none' | 'partial' | 'complete', required
      - `includedLineCount` number, required
      - `totalLineCount` number, required
      - `coveredConversationCount` number, required
      - `totalConversationCount` number, required
      - `coveragePct` number, 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/5241805fe425?raw)