get /api/v2/poi/analytics/{id}/time-series
Python SDK method: client.poi.analytics(id=job_id).time_series_results()
Get Site Intelligence analytics time series results Returns paginated time-series Site Intelligence analytics rows for a completed Site Intelligence analytics time-series child analysis. Each row represents aggregated Site Intelligence analytics for one location at one aggregation-unit bucket. To generate time series, set generateTimeSeries parameter to true on the original analysis along with aggregationUnits.
Altitude Help Center — POI Location Specific Insights API Input Parameters Name Location Type Values Description Value Required idpath string - Unique resource identifier. Y pageTokenquery 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 aggregationUnitstring Time aggregation unit. aggregationValuestring Time aggregation bucket value. inputIdstring Input Site Intelligence location identifier used to anchor the analysis. inputNamestring Input Site Intelligence location name used to anchor the analysis. inputTypestring Input location type for the time-series row, typically POI. input_iso_3166_2string ISO 3166-2 region code for the input Site Intelligence location. locationIdstring Returned Site Intelligence location identifier. locationNamestring Returned Site Intelligence location name. location_iso_3166_2string ISO 3166-2 region code for the returned Site Intelligence location. stopCountinteger Observed stop count. stopCountByFuelTypearray<object> Stop count breakdown by fuel type. Attributes (2)Name Type Description fuelTypestring Vehicle fuel type. stopCountinteger Stop count for this fuel type.
stopCountByVehicleClassarray<object> Stop count breakdown by vehicle class. Attributes (6)Name Type Description categoryIndexinteger Vehicle category index. schemeIdinteger Vehicle class scheme identifier. stopCountinteger Stop count for this vehicle class. vehicleClassstring Vehicle class label. vehicleClassIdstring Stable vehicle class identifier. vehicleClassIndexinteger Vehicle class index.
stopCountByVocationarray<object> Stop count breakdown by vocation. Attributes (3)Name Type Description stopCountinteger Stop count for this vocation. vocationstring Vocation label. vocationIdinteger Unique vocation identifier.
stopDurationAvgnumber Average stop duration (minutes). stopDurationBinsarray<object> Stop duration histogram buckets. Attributes (4)Name Type Description binstring Stop duration bucket label. lowerBoundnumber Inclusive lower bound for the bucket. stopCountinteger Stops counted in this bucket. upperBoundnumber Inclusive upper bound for the bucket.
stopDurationMednumber Median stop duration (minutes).
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.