submit_heatmap
Submit a temperature heatmap request for a specified area, returning an activity ID for asynchronous retrieval via check_status. Supports date/time filters and analytic options.
Instructions
Submit a temperature heatmap over an area and return immediately with an activity_id, without waiting for it to finish. Use this when you have other work to do, or for a large area. Collect it with check_status. If this exact request was run before, the stored result comes back straight away instead of an activity_id, marked from_archive, and costs nothing. filter_type: 1 = single hour (start_date + start_time); 2 = range of hours, same day (start_date + start_time + end_time); 3 = single day (start_date only); 4 = range of days (start_date + end_date). granularity is the tile edge in metres (60, 80, 100); omit it to let the API choose. analytic_type is optional (tcm, time_of_measure, exceedance, persistence); omit it for plain temperature. start_time is interpreted as local time at the area of interest, not UTC.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | YYYY-MM-DD, for filter_type 4. | |
| end_time | No | HH:MM, for filter_type 2. | |
| direction | No | ||
| threshold | No | ||
| start_date | No | YYYY-MM-DD. | |
| start_time | No | HH:MM, local to the area, not UTC. | |
| filter_type | No | 1 = single hour (start_date + start_time); 2 = range of hours, same day (start_date + start_time + end_time); 3 = single day (start_date only); 4 = range of days (start_date + end_date) | |
| granularity | No | Tile edge in metres: 60, 80, 100. | |
| polygon_aoi | Yes | Area of interest as GeoJSON. | |
| analytic_type | No | Optional analytic: tcm, time_of_measure, exceedance, persistence. |