Get observed counts time series results

Returns paginated time-series observed counts rows for a completed observed counts time-series child analysis. Each row represents traversal counts for one zone at one aggregation-unit bucket. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.

Altitude Help Center — getObservedCounts

Input Parameters

Name	Location	Type	Values	Description	Value Required
`id`	path	string	-	Unique resource identifier.	Y
`pageToken`	query	string	-	Pagination token returned in the Link header of a previous response. Omit to fetch the first page.	N

Success Responses

200 response: object

Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.

Name	Type	Description
`aggregationUnit`	string	The time-based unit by which to aggregate data (e.g. 'Hour', 'HourOfDay', 'DayOfWeek', 'Day', 'Month').
`aggregationValue`	string	The associated AggregationUnit value. Format: hour — 0–23; hourofday — YYYY-MM-DDTHH:00:00; dayofweek — 1–7; day — YYYY-MM-DD; month — 1–12.
`cardinalDirection`	string	The direction of the road segment in terms of 'N', 'NE', 'E', etc.
`direction`	integer (int64)	The direction of travel of the road segment, either 1 or -1.
`iso_3166_2`	string	The ISO 3166:2 code of the zone.
`noSegmentMonths`	array<string>	An array of all months for which the segment did not exist and there are no segment predecessors.
`observedCount`	integer (int64)	The total observed count for this aggregation bucket.
`observedCountByFuelType`	array<object>	Array of objects representing the observed count of traversals and vehicles for each fuel type.
`observedCountByVehicleClass`	array<object>	Array of objects representing the observed count of traversals and vehicles for each vehicle class.
`observedCountByVocation`	array<object>	Array of objects representing the observed count of traversals and vehicles for each vocation.
`roadType`	string	The road type of the road segment.
`segmentId`	string	The ID of the road segment for which observed counts are being reported.
`usedSegmentHistory`	boolean	Indicates whether segment predecessors have been utilized (true) or not (false).
`vehicleCount`	integer (int64)	The aggregate number of vehicles observed for this aggregation bucket.
`zoneCode`	string	Raw zone code (e.g. county FIPS, ZIP code, custom zone ID).
`zoneId`	string	Encoded zone identifier for use in subsequent API requests.
`zoneName`	string	Description of the zone when available. The value is based on the type of zone: 'State' — state name, 'County' — county name, 'City' — city name, 'CTR' — census tract description, 'Segment' — road name if available, 'Custom' — custom zone name.
`zoneType`	string	The zone type of the zone.

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.
404	The requested resource does not exist.
409	Result not yet ready. Poll the status monitor.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.