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

# Get store customer maps (v2)

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

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/discovery/store-customer-maps-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 where a physical-location campaign's customers live, with their conversations dated in the 30 days ending its results window's as-of day (`scope.window`): each mapped customer's home point, store, conversation outcome, and the brands their conversations named, every outcome by store, and how many customers the map could not place.

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

- DiscoveryStoreCustomerMapsGetV2Response
  - `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.
  - `customers` DiscoveryCustomers, required
    - `points` object[], required
      - `totalConversations` number, required
      - `mentioned` number, required
      - `won` number, required
      - `positive` number, required: Conversations whose target-brand record carried a positive tone.
      - `negative` number, required: Conversations whose target-brand record carried a negative tone.
      - `customerId` string, required
      - `latitude` number, required
      - `longitude` number, required
      - `locationKey` string, nullable, required: The store the customer was generated for; null for an unbound one.
      - `choices` object[], required: Every recorded choice, including repeated conversations.
        - `brand` string, required
        - `count` number, required
        - `isTarget` boolean, required
      - `lastEndedAt` string, nullable, required: When the customer's latest conversation of the read ended (ISO); null for a customer not heard in it.
    - `unmapped` number, required: Roster members with no usable home point.
    - `total` number, required: Roster members the read holds, mapped or not.
    - `truncated` boolean, required: True when the campaign holds more mapped customers than the map returns.
    - `siteOutcomes` object[], required: Every outcome of the read by assigned store, unmapped customers included.
      - `totalConversations` number, required
      - `mentioned` number, required
      - `won` number, required
      - `positive` number, required: Conversations whose target-brand record carried a positive tone.
      - `negative` number, required: Conversations whose target-brand record carried a negative tone.
      - `locationKey` string, nullable, required
      - `choices` object[], required: Every recorded choice, including repeated conversations.
        - `brand` string, required
        - `count` number, required
        - `isTarget` boolean, 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)