discovery

Get dashboard views

Show one Discovery dashboard view (Brand share, Brand win rate, Competitors, Brands map, Locations) exactly as the Point11 dashboard draws its card: its values as of the campaign's results window, each with its change against 30 days before, its trend and its precision. id is the campaign; view, date_range, brand_perspective and Locations' geography and geography_view are as discovery_dashboard_views_list lists them. Answers the view's title, applied filters and their labels, the results window, the card's display model (snapshot, which Point11's view renders) and the dashboard page that shows it (canonicalHref). A campaign with no results in the range is refused (PRECONDITION_FAILED).

get/api/v1/discovery/dashboard-views/{id}

Request

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

view'discovery_brand_share_trend' | 'discovery_brand_win_rate_trend' | 'discovery_competitor_leaderboard' | 'discovery_brand_map' | 'discovery_win_rate_by_location' required

The dashboard view, as discovery_dashboard_views_list lists it.

date_rangestring required

Required. Use "all" or one absolute UTC-day range in yyyy-MM-dd..yyyy-MM-dd form. Preset names are not accepted because a saved answer must not move over time.

brand_perspectivestring

Optional exact brand name for the dashboard's read-only perspective. Omit for the campaign's target brand.

geographystring

Optional exact navigable dashboard-scope id or unambiguous visible label of a place with places under it, for example "Texas". Omit for World, the dashboard default scope.

geography_view'map' | 'list'

Optional. "list" for the ranked table, or "map" for the countries filled on a world map, which is drawn only at World (no geography). Omit for the map where it can be drawn, else the list.

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

view'discovery_brand_share_trend' | 'discovery_brand_win_rate_trend' | 'discovery_competitor_leaderboard' | 'discovery_brand_map' | 'discovery_win_rate_by_location' required

The view's id.

versioninteger required

The version of the view's snapshot; its card draws only its own.

titlestring required

The view's title, as its card's host shows it.

snapshotobject required

The view's card's display model, which only Point11's view renders. Non-finite numbers are tagged objects; its shape is versioned by version.

snapshotDigeststring required

SHA-256 of the view's id, version and snapshot: two answers with the same digest draw the same card.

canonicalHrefstring required

The dashboard page that shows the view, under the same filters.

Changes

No recorded changes to this operation across all 1 revision of this API.