discovery

Create dashboard view images

Draw 1 to 12 Discovery dashboard views as PNG images for slides, documents or messages, each exactly the card the Point11 dashboard draws with a footer naming its view, campaign, filters, results window and as-of day; each views entry is a view as discovery_dashboard_views_get takes it (discovery_dashboard_views_list lists them). Answers each image's id, size, provenance, a small preview and a download link that works for five minutes (discovery_dashboard_view_images_download fetches the file again); an identical image is answered without drawing it again, images are kept 30 days, and drawing them is free.

post/api/v1/discovery/dashboard-view-images/create

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/dashboard-view-images/create
  • 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)

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

format'slide' | 'square' | 'card' required

slide: a 16:9 frame (1600×900 at scale 1); square: 1080×1080; card: the card at its reading width (1008), as tall as it draws.

theme'light' | 'dark'

light (the default, for slides) or dark.

scale1 | 2

Image pixels per frame pixel: 2 (the default; crisp on projectors) or 1.

Response

Success.

Changes

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