---
title: "Get store maps (v4)"
method: GET
path: "/api/v1/discovery/store-maps-v4/{id}"
tags: ["discovery"]
---

# Get store maps (v4)

`GET /api/v1/discovery/store-maps-v4/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/store-maps-v4/{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 a physical-location campaign's store map: each store's location, brand share, win rate, sentiment, and revenue influence over the conversations dated in the 30 days ending its results window's as-of day (`scope.window`).

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

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- DiscoveryStoreMapsGetV4Response
  - `scope` DiscoveryScope, required
    - `campaignId` string, required
    - `state` 'ready' | 'running' | 'failed' | 'out-of-range' | 'no-campaign', required: `ready` carries results; every other state carries none.
    - `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.
    - `window` object, nullable, required: The results window; null unless `state` is `ready`.
      - `from` string, date, required: The first UTC day a trend plots: the range's, never before the first interaction.
      - `to` string, date, required: The last UTC day a trend plots: the range's end, never past today.
      - `asOf` string, date, required: The UTC day every single value is as of: its value is the average over the campaign's interactions dated in the 30 days ending with it. The range's end, or, when those 30 days hold none, the last day with an interaction.
      - `comparedTo` string, date, required: The day a change compares with: 30 days before asOf.
      - `interactionCount` integer, required: The interactions dated in the 30 days ending asOf, under the scope.
      - `customerCount` integer, required: The distinct customers of those interactions.
  - `map` object, nullable, required: Null unless `scope.state` is `ready`.
    - `state` 'ready' | 'partial' | 'unmappable' | 'no_results', required
    - `targetKind` 'physical_locations', required
    - `brandUrl` string, nullable, required: The campaign's website.
    - `sites` object[], required
      - `locationKey` string, required
      - `ordinal` number, required
      - `label` string, required
      - `storeId` string, nullable, required
      - `street` string, nullable, required
      - `city` string, nullable, required
      - `region` string, nullable, required
      - `postalCode` string, nullable, required
      - `country` string, nullable, required
      - `latitude` number, nullable, required
      - `longitude` number, nullable, required
      - `coordinateSource` 'campaign_premise' | 'verified_permanent_geocode', nullable, required
      - `unplacedReason` 'no_coordinates' | 'conflicting_verified_records', nullable, required: Why the map cannot place the store; null whenever it has coordinates.
      - `googlePlaceId` string, nullable: The Google listing the store was picked from at setup.
      - `storeState` 'active' | 'setting_up' | 'failed' | 'removed': removed once a settings Save stopped measuring the store (its results before then stay); setting_up or failed while a store a Save added sets up; active otherwise.
      - `removedAt` string, date-time, nullable: When a settings Save stopped measuring the store.
      - `assignedCustomers` number, required
      - `totalConversations` number, required
      - `mentioned` number, required
      - `won` number, required
      - `brandSharePct` number, required
      - `brandWinRatePct` number, required
      - `positive` number, required
      - `negative` number, required
      - `positiveSentimentPct` number, required
      - `negativeSentimentPct` number, required
      - `revenueInfluencedUsd` number, nullable, required: Null unless the read carries the target brand's revenue.
      - `revenueInfluenceableUsd` number, nullable, required
      - `revenueEligibleCustomerCount` number, required
      - `change` object, nullable: The store's as-of value minus its value in the window that ends 30 days before the as-of day; each null when either window holds no reading.
        - `brandSharePts` number, nullable, required
        - `brandWinRatePts` number, nullable, required
        - `revenueInfluencedUsd` number, nullable, required
    - `totalPremises` number, required
    - `coordinateReadyPremises` number, required
    - `failedPremises` number, required
    - `analysisAssignedPremises` number, required
    - `unassignedCustomers` number, required
    - `totalConversations` number, required
    - `segments` object[], required: The segments every figure was narrowed to, ANDed; empty is the whole campaign.
      - `axis` 'audience' | 'channel' | 'market' | 'age' | 'householdIncome' | 'education' | 'lifeStage' | 'areaType' | 'companySize' | 'buyerRole' | 'seniority' | 'occupation' | 'job' | 'triggerType' | 'intentStage' | 'language' | 'gender' | 'product' | 'engine' | 'competitor' | 'topic' | 'sentiment' | 'store' | 'customer', required: A pinned customer attribute (audience, channel, age, …); conversation evidence (`product` for the business's products, `engine`, `competitor`, `topic`, `sentiment`); or one `store` or `customer`.
      - `id` string, required: The member's id on that axis, as `discovery.segment-options.get` lists it.
    - `revenue` object, nullable, required: Null under a competitor lens or when no product (revenue line) with market assumptions covers the campaign.
      - `coverage` 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
      - `totalInfluencedUsd` number, required
      - `totalInfluenceableUsd` number, required
      - `eligibleCustomerCount` number, required
      - `unassignedInfluencedUsd` number, required: Dollars whose customers bind to no configured store.

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