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

# Get brand maps (v4)

`GET /api/v1/experience/brand-maps-v4/{id}`

## Request

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

Get an Experience campaign's Brands map over the results window experience_campaign_analytics_get_v9 reads, under optional customer segments: the own website against each competitor its customers also shopped, over matched pairs (one customer's visits to both in a cycle, on one device). Each competitor carries both sides' Experience Score, pass rate and stars over those pairs, the gap in points, its Experience dollars, and the pairs the website won and lost (a pass beats a failure; of two passes more stars win; the rest decide nothing). Beside them: the own website's score over all its journeys, and its dollars by product with each product's assumptions and point value, valued as experience_campaign_analytics_get_v9 values them. No figure carries an interval or noise flag. Answers the campaign's scope and progress as experience_campaigns_get_v3 does.

## Path parameters

- `id` string, uuid, required: The Experience campaign's id

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ExperienceBrandMapsGetV4Response
  - `latestEntry` ExperienceLatestEntry, required
    - `id` string, required
    - `sequence` integer, required: The entry's ordinal among its campaign's entries, from 1.
    - `failureReason` string, nullable, required: The code the entry settled with when it failed or was cancelled (for example no_unit_delivered or no_eligible_customers); null otherwise, or when it recorded no code.
    - `progress` ResearchProgress, required: The entry's units, counted from its product's delivered evidence.
      - `unitLabel` 'visit' | 'interview' | 'conversation', required: What one unit of this entry's work is: an Experience visit, a Research interview, a Discovery conversation.
      - `admission` 'entry' | 'unit', required: `entry`: the entry's work is admitted and billed once; `unit`: each unit is.
      - `counts` object, required
        - `admitted` integer, required: Units admitted to run.
        - `delivered` integer, required: Settled units the product counts as delivered.
        - `failed` integer, required: Units that ended without delivering: counted as each one ends where the entry's work is admitted once, and when a unit's own admission settles where each unit is.
        - `open` integer, required: Units that have not ended yet.
      - `outcome` 'running' | 'succeeded' | 'failed' | 'cancelled' | 'partial', required: Running until the entry settles; failed or cancelled when its product settled it so (a failed final result still counts the units it delivered); otherwise counted from the units: succeeded when every admitted unit delivered, partial when some did, failed when none did. An entry its product settled succeeded whose units no longer exist (all counts 0) stays succeeded.
      - `failureReasons` object[], required: Why the failed units failed, one row per reason with how many units it ended. A unit that failed while its admission still runs has no reason until that settles.
        - `reason` string, required
        - `count` integer, required
  - `campaign` ExperienceCampaign, required
    - `id` string, required
    - `key` string, required
    - `name` string, required
    - `mode` 'pulse' | 'burst', required
    - `status` 'active' | 'paused' | 'archived' | 'deleted', required
    - `objective` string, nullable, required
    - `profileUrl` string, required
    - `sourceDiscoveryCampaignName` string, nullable, required
    - `locationCount` integer, required
    - `pulseSampleEvery` integer, nullable, required
    - `createdAt` string, date-time, required
    - `agents` string[], required: The agents the campaign's cycles shop with from now, in product order: the segment scope's agent options (experience_campaign_segments_get's agents). point11 is Point11's own shopper; every other is simulated: the model its vendor's consumer agent runs, in Point11's browser
  - `destinations` object[], required
    - `id` string, required
    - `name` string, required
    - `url` string, nullable, required
    - `hostname` string, nullable, required
    - `isOriginalTarget` boolean, required
  - `selectedDestination` object, nullable, required
    - `id` string, required
    - `name` string, required
    - `url` string, nullable, required
    - `hostname` string, nullable, required
    - `isOriginalTarget` boolean, required
  - `dateScope` ExperienceDateScope, required
    - `window` object, nullable, required: The window the figures actually cover; null is all time
      - `from` string, date-time, required
      - `to` string, date-time, required
    - `widenedToAllTime` boolean, required
    - `availableDateRange` object, nullable, required: The days of the campaign's first and last interaction under the segment scope; null before its first
      - `from` string, date, required
      - `to` string, date, required
    - `outOfRange` object, nullable, required: Set when the requested window holds none of the campaign's interactions: the days of its first and last
      - `firstDay` string, date, required
      - `lastDay` string, date, required
  - `results` ExperienceResults, nullable, required: Every figure is over the campaign's interactions dated in the 30 UTC days ending with its day: a single figure as of asOf, a line one point per day from `from` to `to`. Null when the campaign has no interaction on or before the range's end under the scope
    - `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.
    - `campaignCustomerCount` integer: Under a segment scope: the whole campaign's distinct customers in the same 30 days on the same website, unscoped (customers a precision order added for a group count only in that group's readings). Absent when the read is unscoped, whose customerCount is the campaign's.
    - `bucketCustomerCount` integer: Under a scope that names a customer bucket (an attribute or a store): the distinct customers inside it in the same 30 days. Absent without one.
  - `scopeEntries` object[], required: The read's customer and store segment entries the campaign holds, each with its label, in the order asked. An entry the campaign does not hold is not listed, and narrows the read to nothing. The agent entry is scopeAgent.
    - `axis` 'customer' | 'store', required
    - `id` string, required
    - `label` string, required: The entry's name, as experience_campaign_segments_get names it
  - `scopeAgent` object, nullable, required: The agent entry the read applied: every figure is of that agent's visits alone. Null when the segment scope names no agent: the figures pool every agent's visits, and instrument names each agent's changes
    - `id` 'point11' | 'dots' | 'spark' | 'muse' | 'grok_bot', required
    - `label` string, required: The agent's brand, as experience_campaign_segments_get names it
  - `competition` ExperienceCompetition, required: What every read against competitors stands on, so a reader can say why revenueValue is null, or why a campaign has no Brands map or Matrix to draw
    - `ownWebsite` boolean, required: The campaign has one website of its own to set against competitors: its measured site, else its one page. False for a campaign of several pages and no measured site, which states no gap and no dollars
    - `shopsCompetitors` boolean, required: Discovery named a competitor for the campaign, ready to shop or not. False for a campaign that shops its own website alone, which has nothing to be valued against and no Brands map to draw
    - `readsDiscovery` boolean, required: The campaign names a Discovery campaign the organization still holds, the one its competitors and how often AI picks each brand are read from. False when it names none or the one it named is gone, so the Matrix map has nothing to plot
  - `metrics` object, required
    - `plannedCount` integer, required
    - `finishedCount` integer, required
    - `queuedCount` integer, required
    - `runningCount` integer, required
  - `destinationIcons` object, required: Each website's stored favicon by destinations[].id; one without (no URL, or none stored) is absent and draws its name's initial
  - `map` object, nullable, required: Null while the scope holds no interaction, and for a campaign with no single website of its own: one that measures no site and tests several pages
    - `datasetKey` string, required: Names what the map was read from: the campaign, website, the day its results window is as of with the interactions it holds, and the segment scope. experience.competitor-reasons.get answers the same key while it describes the same map
    - `website` object, required: The campaign's own website, which the map is always read for
      - `id` string, required
      - `name` string, required
    - `experienceScore` number, nullable, required: The website's Experience Score over every journey judged on it: experience.campaign-analytics.get's figure for the same scope
    - `judgedJourneys` integer, required: The journeys that score stands on: the pass rate's denominator
    - `value` ExperienceRevenueValue, required
      - `foundPairs` integer, required: Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on
      - `matchedPairs` integer, required: Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides
      - `ourMatchedScore` number, nullable, required: The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs
      - `competitorScore` number, nullable, required: The competitors' Experience Score over the same pairs, each weighted by its matched pairs
      - `gapPts` number, nullable, required: ourMatchedScore less competitorScore, in points
      - `customers` integer, required: Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)
      - `experienceUsd` number, nullable, required: Experience dollars, plus or minus against the competitors: the lines' experienceUsd added up, each line valued apart; null when no line has any. They are over the lines with economics, while gapPts beside them is over every comparison, so the two do not multiply into each other
      - `valuedLines` integer, required: How many of lines have experienceUsd
      - `valuedCustomers` integer, required: Distinct customers behind the pairs of the revenue lines with economics, each once however many of those lines its scenarios froze: the sample the dollars' precision reads; 0 without dollars
      - `passRate` object, required: The site pass rate over the matched pairs, 0 to 100, ours and the competitors'
        - `oursPct` number, nullable, required
        - `theirsPct` number, nullable, required
        - `gapPts` number, nullable, required: oursPct less theirsPct, in points
      - `averageStars` object, required: Mean stars over the rated journeys of the matched pairs, ours and the competitors'
        - `ours` number, nullable, required
        - `theirs` number, nullable, required
      - `lines` object[], required: Every product (revenue line) with a matched pair, most AI-influenced sales first; the journeys of no product are one of them, with assigned false
        - `id` string, required: The product's id: its revenue line id
        - `label` string, required
        - `assigned` boolean, required: False for the journeys whose scenario names no product (revenue line): they count in every gap and have no economics and no dollars
        - `economics` object, nullable, required: The line's company-scope market assumptions in Tools › Products today, as business.revenue-lines.list values them; null without complete assumptions
          - `annualSalesUsd` number, required
          - `aiInfluencePct` number, required
          - `serviceableAvailableMarketUsd` number, required: SAM: annual sales ÷ market share
          - `aiInfluencedSalesUsd` number, required: Annual sales × AI influence: the brand's own sales AI assistants influence
          - `aiInfluencedMarketUsd` number, required: SAM × AI influence, a year: one point of the gap is a hundredth of it
        - `point` object, nullable, required: What one point of Experience Score gap is worth on the line, aiInfluencedMarketUsd ÷ 100; null without economics or a matched score
          - `pointValueUsd` number, required: One point of the line's gap, in dollars
          - `basis` 'ceiling', required: Always ceiling: a point is aiInfluencedMarketUsd ÷ 100, whatever the score
        - `foundPairs` integer, required: Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on
        - `matchedPairs` integer, required: Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides
        - `ourMatchedScore` number, nullable, required: The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs
        - `competitorScore` number, nullable, required: The competitors' Experience Score over the same pairs, each weighted by its matched pairs
        - `gapPts` number, nullable, required: ourMatchedScore less competitorScore, in points
        - `customers` integer, required: Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)
        - `experienceUsd` number, nullable, required: point.pointValueUsd × gapPts, plus or minus; null without a point or a gap
        - `competitors` object[], required: The line against each competitor, most pairs found first
          - `id` string, required: The competitor's website id, as destinations[].id names it
          - `foundPairs` integer, required: Every matched pair there is, whether or not both sides have an Experience Score yet: matchedPairs plus the pairs of the comparisons a side has no score on
          - `matchedPairs` integer, required: Matched pairs: one journey on the campaign's website with the same customer's journey on one competitor's, so a customer who shopped three competitors is three pairs. Counted over the comparisons with an Experience Score on both sides
          - `ourMatchedScore` number, nullable, required: The campaign's own website's Experience Score over the matched pairs alone, 0 to 100, each competitor weighted by its matched pairs
          - `competitorScore` number, nullable, required: The competitors' Experience Score over the same pairs, each weighted by its matched pairs
          - `gapPts` number, nullable, required: ourMatchedScore less competitorScore, in points
          - `customers` integer, required: Distinct customers behind the pairs found: the sample the gap's precision reads (98/√n points, Standard at ±5.0 or tighter: 385 customers)
          - `experienceUsd` number, nullable, required: This competitor's part of the line's dollars: the line's point by its share of the line's matched pairs, × its gap. A line's parts add up to the line, to the cent
      - `competitors` object[], required: Each competitor's dollars across the lines; they add up to experienceUsd, to the cent. Largest in size first
        - `id` string, required
        - `experienceUsd` number, nullable, required
        - `valuedPairs` integer, required: The competitor's matched pairs on the lines its experienceUsd is parts of: the pairs its dollars stand on, none of a line without economics; 0 without dollars
        - `valuedCustomers` integer, required: Distinct customers behind the competitor's pairs on the revenue lines with economics, each once; 0 without dollars
    - `sizedBy` 'usd' | 'journeys', required: The unit of every size: usd (the size of experienceUsd, whichever way it points) when any match has dollars, else matched pairs
    - `competitors` ExperienceCompetitorsItem[], required: From the competitor the website leads by most to the one that leads it by most, then those with no gap to state
      - `id` string, required: The competitor's website id, as destinations[].id names it
      - `name` string, required
      - `matchedPairs` integer, required: Matched pairs: one visit to the campaign's website and the same customer's visit to the competitor's in the same cycle, on the same device. Against one competitor a pair is one journey of the campaign's website
      - `customers` integer, required: Distinct customers behind the matched pairs
      - `wins` integer, required: The matched pairs the campaign's website won: its journey passed and the competitor's failed, or both passed and its journey earned more stars
      - `losses` integer, required: The matched pairs the competitor won, by the same rule. The rest decide nothing (both failed, equal stars, a pass with no stars, or a failure blamed on the shopper), so wins plus losses can be fewer than matchedPairs, and the record can point the other way from gapPts
      - `ours` object, required: The campaign's own website over the matched pairs only, so it can differ from the website's own score
        - `experienceScore` number, nullable, required: The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim
        - `passRatePct` number, nullable, required: The site pass rate over this side of the matched pairs, 0 to 100
        - `averageStars` number, nullable, required: Mean stars over this side's rated journeys in the matched pairs
        - `judgedJourneys` integer, required: This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper
      - `theirs` object, required
        - `experienceScore` number, nullable, required: The Experience Score of this side of the matched pairs, 0 to 100, valued as experience.campaign-analytics.get values a segment's; null when it has none to claim
        - `passRatePct` number, nullable, required: The site pass rate over this side of the matched pairs, 0 to 100
        - `averageStars` number, nullable, required: Mean stars over this side's rated journeys in the matched pairs
        - `judgedJourneys` integer, required: This side's journeys in the pass rate's denominator: all but the failures blamed on the shopper
      - `gapPts` number, nullable, required: Our score less theirs, in points; null unless both sides have a score
      - `experienceUsd` number, nullable, required: The match's Experience dollars, plus or minus: a competitor's across the business's products, its revenue lines (its parts of the lines added up, so their sign can differ from gapPts's), or a line's against one competitor; null without a worth or a gap to value
      - `valuedPairs` integer, required: The matched pairs experienceUsd stands on: a competitor's on the products (revenue lines) with a worth, which can be fewer than matchedPairs; a line's own. 0 without dollars
      - `valuedCustomers` integer, required: Distinct customers behind valuedPairs: the sample the dollars' precision reads, as customers is the gap's. 0 without dollars
      - `size` number, required: What the match weighs on the map, in sizedBy's unit
    - `shopsCompetitors` boolean, required: Discovery named a competitor for the campaign, ready to shop or not: with competitors empty, whether its pairs have yet to match or the campaign has none to match
    - `coverage` object[], required: What each website the map sets side by side stands on in the as-of window: the campaign's own and every competitor Discovery named, matched or not, so a competitor that walls off the shopper reads as blocked beside the pairs it left
      - `id` string, required: The website's id, as destinations[].id names it
      - `measured` integer, required: Interactions in the as-of window: visits whose scorer gave a verdict
      - `couldNotTell` integer, required: Visits the scorer could not tell for a reason other than blocked; in no pair
      - `blocked` integer, required: Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no pair
    - `instrument` object, required: The instrument changes among the as-of window's interactions the map pools; each marks every figure on it
      - `changes` object[], required: Each instrument change among the interactions the figures read, oldest first
        - `day` string, required: The UTC day from which the changed instrument measured
        - `kind` 'scorer' | 'shopper' | 'models' | 'browser', required: scorer: the scoring call's prompt, task or answer schema version moved; shopper: the shopper's Computer Use call's prompt or task version moved; models: the frozen model plan the visits ran under changed, between cycles or re-frozen mid-cycle; browser: the browser conditions one website's visits on one device were frozen under changed (emulation, frame, automation waits, certificate, ad and CAPTCHA settings, connection access). Each marks every figure of the read, whichever website it was measured on
        - `version` string, nullable, required: The call versions measured from day, joined by ' · ': a scorer's prompt, task and answer schema versions, a shopper's prompt and task versions; null for a models or browser change
        - `agents` string[], required: The agents whose visits it measured differently, in product order: each agent's visits are a series of their own (its models are its own shopper call's and the shared ones, never another agent's), so a repin of one agent's model names that agent alone, and a read of every agent names each agent's changes
      - `comparable` boolean, required: No change falls between the start of the window ending results.comparedTo and results.asOf, so every change compares like with like; false: the changes span an instrument change and no significance is claimed for them

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