discovery

Get brand matchups

Deprecated: use discovery.brand-matchups.get.v2 (discovery_brand_matchups_get_v2), which reads the campaign's results window and answers a pair's evidence as its decided matchups alone; this version reads the one run dispatchId names, its evidence status none or supported, confident false and wilsonLowerBound 0. Read the head-to-head record between two brands in a campaign's run: wins, win rate, decisiveness, evidence strength, and why the loser loses, optionally within one cohort.

get/api/v1/discovery/brand-matchups/{id}

Request

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

Discovery campaign id.

Query parameters

dispatchIdstring uuid required

The completed dispatch the map was drawn from.

segmentsstring[]

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.

brandAKeystring required

A brand's normalized key (trimmed, single-spaced, lowercase name).

brandBKeystring required

A brand's normalized key (trimmed, single-spaced, lowercase name).

cohortDimension'decision-factors' | 'audiences' | 'engines'

Reads the matchup inside one cohort; omit both cohort fields to read every conversation.

cohortValuestring

The cohort member's id on cohortDimension.

Headers

Point11-Organizationstring uuid

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

Response

Success.

Changes

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