Get revenue reports (v4)
Read a campaign's Products report: for each product of the business (a revenue line: lines[].id), its brand share, win rate, and modeled revenue influence, with drivers and trends, 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/revenue-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
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.
Read every daily trend. Default true; false reads the as-of window and the one 30 days before it alone: lineSeries, segmentCountSeries and every driver's series are empty, and every change stays.
Read each line's win and loss reasons. Default true; false leaves drivers empty.
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.