experience

Get brand matchups (v3)

Deprecated: no successor. The Brands map no longer reads a matchup: a competitor opens its record and why we won and lost (experience.competitor-reasons.get.v2). This version still answers one competitor's matchup from an Experience campaign's Brands map, under the same window and segments: the matched pairs cut by product (revenue line), each with its record of pairs won and lost, and the journeys that failed on the campaign's website while the same customer's goal passed on the competitor's, each with its two replays, over the pairs dated in the 30 UTC days ending with the map's results.asOf, its Experience dollars at each product's point (its AI-influenced market ÷ 100).

get/api/v1/experience/brand-matchups-v3/{id}

Request

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

Path parameters

idstring uuid required

The Experience campaign's id

Query parameters

fromstring date-time

The window's start; with to, or neither for all time

tostring date-time

The window's end; with from, or neither for all time

widenWhenEmptyboolean

When no day of the window has one of the campaign's interactions in its 30 days, read all time instead (dateScope.widenedToAllTime says so). Otherwise such a window reports dateScope.outOfRange.

segmentsstring[]

Customer-level entries as axis:id (ids from experience_campaign_segments_get), ANDed across axes; empty reads the whole cohort. Every customer attribute narrows by its own buckets, a store by its customers. An agent entry names one of point11, dots, spark, muse, grok_bot and narrows every figure to that agent's visits (scopeAgent states it); one at most, and with none every agent's visits are read together.

agent'point11' | 'dots' | 'spark' | 'muse' | 'grok_bot'

The segment scope's agent entry (the object form's {axis: agent}): every figure is of that agent's visits alone; absent reads every agent's

competitorstring required

A competitor's website id, from experience_brand_maps_get_v4's competitors[].id

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

datasetKeystring nullable required

Names what the matchup was read from, as experience.brand-maps.get's map.datasetKey does: equal while both describe the same window, website and segment scope. Null when the scope holds no interaction or website to read

Changes

No recorded changes to this operation across all 1 revision of this API.