discovery

Get location reports (v2)

Read a campaign's Locations report over the conversations dated in the 30 days ending its results window's as-of day (scope.window): its customers rolled up country → region → city → postcode, with each place's brand share and win rate and their change since 30 days before the as-of day, its win and loss reasons, and revenue influence, under an optional brand lens and segments. Pass drivers=false or revenue=false to skip those reads.

get/api/v1/discovery/location-reports-v2/{id}

Request

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

driversboolean

Read each place's win and loss reasons. Default true; false leaves drivers empty.

revenueboolean

Read revenue influence. Default true; it is read only under the campaign's own brand.

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 2 revisions of this API.