/api/preview_embed

GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}

Changed on

Generates a single tile image for an embedded Card using the map visualization.

get/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

tokenstring required
zoominteger required

value must be an integer.

xinteger required

value must be an integer.

yinteger required

value must be an integer.

Query parameters

idstring required

Schema for a string that cannot be blank.

namestring

Schema for a string that cannot be blank.

sectionIdstring

Schema for a string that cannot be blank.

slugstring

Schema for a string that cannot be blank.

type'number' | 'text' | 'date' | 'boolean' | 'date/single' | 'id' | 'category' | 'location/city' | 'location/state' | 'location/zip_code' | 'location/country' | 'date/range' | 'date/month-year' | 'date/quarter-year' | 'date/relative' | 'date/all-options' | 'temporal-unit' | 'number/!=' | 'number/<=' | 'number/=' | 'number/>=' | 'number/between' | 'string/!=' | 'string/=' | 'string/contains' | 'string/does-not-contain' | 'string/ends-with' | 'string/starts-with' | 'boolean/='

Valid parameter :type

unknown required
unknown required

Response

Successful response

Changes

    • info

      for the query request parameter latField, the type was generalized from string to no type

    • info

      for the query request parameter lonField, the type was generalized from string to no type

    • info

      for the query request parameter parameters, the type was generalized from string to no type

    • info

      api operation id get-api-preview_embed-tiles-card-token-zoom-x-y was added