Visualizations

Generate an index PNG for a visualization

Generates an on-the-fly PNG of the index for a given date and mode, with legend overlay. Returns the PNG image as binary data.

post/v0/aois/{aoi_id}/visualizations/{visualization_id}/png

Request

Base URL
https://api.pixxel.space
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/pixxel/apis/stargate/docs/v0/aois/:aoi_id/visualizations/:visualization_id/png/post.ts
A function with typed inputs. Its response is checked against the schema.

aoi_idstring required

AOI ID

visualization_idstring required

Visualization ID

index_idstring required

UUID of the index to compute the preview for

datestring required

Date string, e.g. 2024_05_06

visualization_mode'dynamic' | 'theoretical' required

Legend mode to use: 'dynamic' or 'theoretical'

{
  "index_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "date": "2024_05_06",
  "visualization_mode": "dynamic"
}

No recorded changes to this operation across all 2 revisions of this API.