Start Site Intelligence summary job

Creates a job to generate a Site Intelligence summary analysis. Aggregates vehicle stop statistics per point-of-interest location, providing counts, average dwell times, and vehicle class breakdowns.

Altitude Help Center — POI Location Specific Insights API

Request Body

Site Intelligence analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`dateFrom`	string (date)	-	-	First date of the analysis range, formatted as yyyy-mm-dd.	Y
`dateTo`	string (date)	-	-	Last date of the analysis range (inclusive), formatted as yyyy-mm-dd.	Y
`isMetric`	boolean	-	false	Site Intelligence Summary currently supports imperial units only. Set this to false. Defaults to false when omitted.	N
`locationIds`	array<string>	-	-	List of location IDs returned by the site locations analysis.	Y
`naicsLevel2`	array<integer>	-	-	NAICS Level-2 industry codes to include. An empty array includes all licensed industries.	N
`radius`	number	-	-	Capture radius around each Site Intelligence in miles. Site Intelligence Summary currently supports imperial units only. Vehicles stopping within this radius are attributed to the Site Intelligence.	Y

Examples

Site Intelligence summary from discovered locations

Use the numeric id returned by the preceding Site Intelligence Locations request.

{
  "dateFrom": "2026-01-01",
  "dateTo": "2026-01-31",
  "isMetric": false,
  "locationIds": [
    "-1003048895383462315"
  ],
  "naicsLevel2": [
    445,
    447
  ],
  "radius": 25
}

Success Responses

202 response: object

Job accepted and queued for processing. Poll the location header URL to check status.

Name	Type	Description
`error`	object	Details about why the job failed (RFC 7807 format), or null if it succeeded.
`id`	string	Unique job identifier.
`links`	object	Navigation URLs for polling and result retrieval.
`status`	string	Current job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status Code	Reason
400	The request body or parameters are invalid.
401	Authentication is required or the provided credentials are invalid.
403	The authenticated user lacks permission to perform this operation.
409	The operation conflicts with the current state of the resource.
422	The request is syntactically valid but semantically cannot be processed.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.