Get map guide image

A picture of one type of map, drawn by the reference drawing

API version

GET/v1/maps/guide/image

The guide's example drawn by its reference drawing, light theme, 640 px square.

Authenticate with an API key in X-Api-Key, or a bearer token in Authorization: Bearer <token>.

Parameters#

Query parameters#

typestring · required
The map to draw.
One of brand_position, demand_space_sizes, brand_profile.
formatstring · default "png"
One of png, svg.
variantstring · nullable · always "position_di"
position_di (with brand_position only).

Example request#

Shell

curl "https://api.odysseysignal.app/v1/maps/guide/image?type=brand_position" \
  -H "X-Api-Key: $ODYSSEY_API_KEY"

Response 200#

image/png or image/svg+xml.

Errors#

Errors are application/problem+json (RFC 9457): type, title, status, detail and, for some, more fields that say how to fix the call. The type is https://api.odysseysignal.app/problems/<code>.

Status	Code	When
400	`invalid-request`	The request is not valid for this DataSet; `detail` says why.
401	`unauthorized`	No credential, or one that is not accepted.
403	`forbidden`	The credential is valid but does not cover what was asked.
404	`not-found`	Nothing there, or nothing this credential may read.
422	`validation-failed`	The request does not match the contract; `errors` lists each field.
429	`rate_limited`	Too many requests, or the monthly quota is used up.
503	`unavailable`	A service behind the API did not answer; try again.