get
/api/v2/stop-analytics/regional-domicile-analytics/{id}Python SDK method:
client.stop_analytics.rda(id=job_id).results()Get regional domicile analytics results
Returns paginated regional domicile analytics rows for a completed RDA job. Each row represents aggregated domicile statistics for one zone.
Altitude Help Center — getRegionalDomicileAnalyticsInput 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 |
|---|---|---|
domDCCount | integer (int64) | Total number of domicile duty cycles for eligible vehicles that have their domicile in the region, calculated as a summation of domicile duty cycles across all eligible vehicles. |
domDCDistanceAvg | number (double) | The average domicile duty cycle distance (kilometers or miles). |
domDCDistanceMed | number (double) | The median domicile duty cycle distance (kilometers or miles). |
domDCDistancePercentiles | array<object> | Array of objects representing percentile domicile duty cycle distance values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default. |
domDCDistanceStdev | number (double) | The standard deviation of domicile duty cycle distance (kilometers or miles). |
domDCDurationAvg | number (double) | The average domicile duty cycle duration (minutes). |
domDCDurationMed | number (double) | The median domicile duty cycle duration (minutes). |
domDCDurationPercentiles | array<object> | Array of objects representing percentile domicile duty cycle duration values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default. |
domDCDurationStdev | number (double) | The standard deviation of domicile duty cycle duration (minutes). |
domMetricsByDayOfWeek | array<object> | Array of objects representing domicile metrics for each day of week, based on domicile duty cycles that stop at their domicile during the day of the week (local time). |
domMetricsByFuelType | array<object> | Array of objects representing domicile metrics for each fuel type. |
domMetricsByHour | array<object> | Array of objects representing domicile metrics for each hour, based on domicile duty cycles that stop at their domicile during the hour (local time). |
domMetricsByIndustry | array<object> | Array of objects representing domicile metrics for each NAICS code 1. |
domMetricsByMonth | array<object> | Array of objects representing domicile metrics for each month, based on domicile duty cycles that stop at their domicile during the month (local time). |
domMetricsByVehicleClass | array<object> | Array of objects representing domicile metrics for each vehicle class. |
domMetricsByVocation | array<object> | Array of objects representing domicile metrics for each vocation. |
domMetricsForVehicleDailyDC | object | An object representing metrics around the average daily domicile duty cycle for a vehicle, including operating days, daily domicile duty cycle count, domicile stop duration, non-domicile stop count and duration, and drive distance and duration. |
domStopDurationAvg | number (double) | The average domicile stop duration (minutes). |
domStopDurationMed | number (double) | The median domicile stop duration (minutes). |
domStopDurationPercentiles | array<object> | Array of objects representing percentile domicile stop duration values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default. |
domStopDurationStdev | number (double) | The standard deviation of domicile stop duration (minutes). |
eligibleDomVehicleCount | integer (int64) | The number of vehicles that meet vehicle filters, have their domicile in the zone and are also deemed eligible for the analysis period based on input eligibility criteria. |
iso_3166_2 | string | Unique ISO 3166-2 identifier representing the state/provincial code of the region. |
nonDomStopDurationAvg | number (double) | The average stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle. |
nonDomStopDurationMed | number (double) | The median stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle. |
nonDomStopDurationPercentiles | array<object> | Array of objects representing percentile non-domicile stop duration values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default. |
nonDomStopDurationStdev | number (double) | The standard deviation of stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle. |
nonDomStopsPerDomDCAvg | integer (int64) | The average number of non-domicile stops per domicile duty cycle. |
nonDomStopsPerDomDCMed | integer (int64) | The median number of non-domicile stops per domicile duty cycle. |
nonDomStopsPerDomDCPercentiles | array<object> | Array of objects representing percentile non-domicile stops per domicile duty cycle values for input percentiles. If no percentiles are input, the 15th and 85th percentiles are provided by default. |
nonDomStopsPerDomDCStdev | number (double) | The standard deviation of non-domicile stops per domicile duty cycle. |
totalDomVehicleCount | integer (int64) | The number of vehicles that meet vehicle filters and have their domicile within the zone. |
zoneCode | string | Raw zone code. |
zoneId | string | The zone ID for which data is being returned. |
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, 'Custom' — custom zone description if available. |
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. |
