discovery

Get channel reports (v4)

Read a campaign's channel report: brand share, win rate, top competitor, and win and loss drivers for each channel, over the campaign's results window (scope.window): every value as of the window's as-of day, averaged over the conversations dated in the 30 days ending it, every trend one point per day (null for a day whose window holds no conversation the value counts), and every change the value minus its value 30 days before the as-of day (null without one). A share or win rate nothing in scope measured is { kind: absent, reason }, never 0.

get/api/v1/discovery/channel-reports-v4/{id}

Request

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

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.

brandPerspectivestring nullable

Read the results as this brand (one of the campaign's brands). Omit for your own.

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.

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.