Get overview reports (v5)
Read a campaign's overview: brand share, win rate, and revenue influence KPIs with trends, competitive position, why the brand wins and loses, and conversation totals, 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.
Request
- Base URL: https://point11.ai
- URL: https://point11.ai/api/v1/discovery/overview-reports-v5/{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
Discovery campaign id.
Query parameters
Result window: all, a preset id, or yyyy-MM-dd..yyyy-MM-dd. Omit for the campaign's default window.
Read the results as this brand (one of the campaign's brands). Omit for your own.
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
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.