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

# Get matrix maps (v4)

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

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/experience/matrix-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 Matrix map over the results window experience_campaign_analytics_get_v9 reads, under optional customer segments. websites: each website shopped, its own and each competitor's (named for its Discovery brand), with Experience Score, site pass rate, judged journeys, its interactions in the window and, apart, visits the scorer could not tell (blocked or otherwise), which no score counts. groupings: each product (revenue line), audience and channel of the own website with its score there and against the competitors the same customers shopped (each side's mean weighted by matched pairs: one customer's journeys on both sites in a cycle, on one device), the gap in points, a product's Experience dollars as experience_campaign_analytics_get_v9 values them, and what its sizes are in. Segment ids are the profile's revenue, audience and channel mix ids, keyed alike by Discovery's reports for the competitorSourceCampaignId campaign, whose win rates say how often AI picks each. No figure carries an interval or noise flag. Answers the campaign's scope and progress as experience_campaigns_get_v3 does, without favicons.

## Path parameters

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

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- ExperienceMatrixMapsGetV4Response
  - `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
  - `map` object, nullable, required: Null while the scope holds no interaction, and for a campaign with no single website of its own
    - `datasetKey` string, required: Names the campaign, website, the day its results window is as of with the interactions it holds, and the segment scope the map was read for
    - `competitorSourceCampaignId` string, uuid, nullable, required: The Discovery campaign the campaign reads its competitors from, whose Products and Audiences reports hold how often AI recommends the brand for each segment; null when it names none the organization still holds
    - `matchedPairs` integer, required: Matched pairs behind the whole map: one per journey of ours and the same customer's on one competitor's website
    - `websites` object[], required: Every website the campaign holds, its own first, then by Experience Score, highest first, those without one last
      - `id` string, required: The website's id, as destinations[].id names it
      - `name` string, required: The website's name; a competitor's is its brand's in the Discovery campaign competitorSourceCampaignId names, as discovery_competitor_reports_get_v5's competitors[].name names it
      - `own` boolean, required: The campaign's own website; every other is a competitor's
      - `experienceScore` number, nullable, required: The website's Experience Score over every journey judged on it in the window, 0 to 100, as experience.campaign-analytics.get states it; null where they leave none to claim
      - `passRatePct` number, nullable, required: The site pass rate over the same journeys, 0 to 100; null with none
      - `judgedJourneys` integer, required: The journeys judged on it: the pass rate's denominator
      - `coverage` object, required: The website's evaluated visits in the as-of window: the measured ones every rate stands on, and those no rate counts
        - `measured` integer, required: Interactions: visits whose scorer gave a verdict (pass or fail), the journeys every rate is over
        - `couldNotTell` integer, required: Visits the scorer could not tell for a reason other than blocked (policy, infrastructure, cut short, does not apply); in no rate
        - `blocked` integer, required: Visits the scorer could not tell because a bot wall, CAPTCHA, access-denied page or login stopped them; in no rate
    - `instrument` object, required: The instrument changes among the as-of window's interactions the map pools; each marks every score 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
    - `groupings` object[], required: Products (revenue lines), then audiences, then channels
      - `key` 'product' | 'audience' | 'channel', required
      - `sizedBy` 'dollars' | 'journeys', required: The unit of the grouping's sizes: dollars (the size of experienceUsd, whichever way it points) for products (revenue lines) when one has Experience dollars, a line without any then weighing 0; otherwise judged journeys
      - `segments` object[], required: Every segment the window judged a journey in, most judged first
        - `id` string, required: The profile's revenue, audience or channel mix id, as discovery_segment_win_rates_get_v2's revenue, audience and channel rows name the same segment; unassigned for journeys whose customer carries none
        - `label` string, nullable, required: The name the campaign's frozen profile gives the segment; null where it names none by that id
        - `judgedJourneys` integer, required: Journeys judged on the campaign's website in the segment, matched or not: the pass rate's denominator
        - `experienceScore` number, nullable, required: The website's Experience Score over the segment's judged journeys, 0 to 100; null where they leave none to claim
        - `matchedPairs` integer, required: Matched pairs behind the gap: one per journey of ours and the same customer's on one competitor's website (same cycle and device), over the competitors with a score on both sides, so a customer who shopped three competitors is three pairs
        - `ownScore` number, nullable, required: The website's Experience Score over the matched pairs, 0 to 100, each competitor weighing as its pairs, so it can differ from the segment's own score; null without a gap
        - `peerScore` number, nullable, required: The competitors' Experience Score over the same pairs; null without a gap
        - `gapPts` number, nullable, required: ownScore less peerScore, in points: the one gap every Experience read states for the segment; null with no matched pair or no score to compare (noGap says which)
        - `noGap` 'no_match' | 'no_score', nullable, required: Why gapPts is null: no_match when no journey of the segment is matched to a competitor's, no_score when it is matched and a side leaves no score; null when there is a gap
        - `experienceUsd` number, nullable, required: A product's (revenue line's) Experience dollars: one point of its gap, its AI-influenced market (SAM × AI influence in Tools › Products) ÷ 100, × gapPts; positive where the website serves AI shoppers better than the competitors' and negative where worse; null for an audience and for a line without market assumptions or a gap
        - `size` number, required: What the segment weighs on the map, in its grouping's sizedBy unit

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