discovery

Get competitor reasons

Deprecated: use discovery.competitor-reasons.get.v2 (discovery_competitor_reasons_get_v2), which reads the results window the caller names and answers each reason's trend as one point per day; this version refuses unless that window's newest measuring run is the dispatchId named, and labels a trend's days with a value. Read why the campaign's brand wins and loses against one competitor, with each reason's frequency and trend. An empty answer means the run records no reasons for that competitor.

get/api/v1/discovery/competitor-reasons/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/competitor-reasons/{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 dispatch the caller read; a newer one refuses.

dateRangestring required

The window the caller resolved: all or yyyy-MM-dd..yyyy-MM-dd.

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.

brandNamestring nullable

The brand whose reasons are read, as the brand map names it; null (the default) reads the campaign's own brand.

competitorKeystring required

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

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.