discovery

Get competitor reasons (v3)

Read why the campaign's brand wins and loses against one competitor over the conversations dated in the 30 days ending its results window's as-of day, with each reason's count and its daily trend (null for a day whose window holds no conversation). An empty answer means the window records no reasons for that competitor.

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

Request

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

Discovery campaign id.

Query parameters

dateRangestring nullable

Result window: all, a preset id, or yyyy-MM-dd..yyyy-MM-dd. Omit for the campaign's default window.

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.