Start regional domicile analytics job

Creates a job to generate a regional domicile analytics (RDA) analysis. Identifies vehicle domicile (home base) zones and returns trip and distance statistics per domicile zone.

Altitude Help Center — getRegionalDomicileAnalytics

Request Body

Analysis parameters.

application/json: object

Name	Type	Input Shape	Values	Description	Value Required
`dateFrom`	string (date)	-	-	Start of the analysis date range (yyyy-mm-dd). The maximum date range is one year.	Y
`dateTo`	string (date)	-	-	End of the analysis date range (yyyy-mm-dd). For domicile calculation a minimum of one month back from dateTo is used; if the range exceeds one month the full range is used.	Y
`eligibilityCriteria`	object	maxDistanceThreshold: number; minDomicileDutyCycles: integer; percentileThreshold: number	-	Optional vehicle eligibility criteria. When supplied, maxDistanceThreshold, percentileThreshold, and minDomicileDutyCycles are all required.	N
`fuelTypes`	array<string>	-	diesel, electric, flexible, gasoline, hybrid, other, unknown	Fuel types to include. Valid values: diesel, electric, flexible, gasoline, hybrid, other, unknown. An empty array includes all fuel types.	N
`industries`	array<string>	-	agriculture, mining, utilities, construction, manufacturing, wholesale, retail, transportation_and_warehousing, information_and_cultural, finance_and_insurance, real_estate, science_and_technology, management, administrative_and_support, education, health_care, arts_and_entertainment, accommodation_and_food, public_administration, other_services, unclassified	Named industry IDs from GET /api/v2/filters/industries (e.g. 'manufacturing', 'retail'). Resolved to NAICS codes at query time and combined with any naics values. Leave both industries and naics empty to include all industries.	N
`isMetric`	boolean	-	-	When true, distance values are returned in kilometres; when false, in miles. Defaults to the unit setting in your user profile when omitted.	N
`minDomicileDutyCycleDistance`	number	-	-	Minimum distance (km or miles) of a domicile duty cycle to include in analysis calculations. Defaults to 0.	N
`minDomicileStopDuration`	integer	-	-	Minimum stop duration (minutes) at the domicile to count as a domicile stop and the end of a domicile duty cycle. Defaults to 0 (all stops included).	N
`naics`	array<integer>	-	-	Explicit raw NAICS integer codes to filter by. Combined with any industries values. Leave both naics and industries empty to include all industries.	N
`percentiles`	array<integer>	-	-	Integer percentiles to compute for domicile metrics (for example 10, 50 and 90). Defaults to the 15th and 85th percentiles when omitted.	N
`vehicleClassIds`	array<string>	-	-	Vehicle class filter IDs from GET /api/v2/filters/vehicle-classes. IDs must use the scheme_vehicleClassIndex_categoryIndex format and share one scheme; IDs that do not name a known vehicle class are rejected. An empty array includes all vehicle classes.	N
`vehicleClassSchemeId`	integer	-	1, 2, 3, 4, 5, 6	Vehicle classification scheme: 1 = VIUS, 2 = GVWR (FHWA), 3 = Truck Weight Classes, 4 = CARB, 5 = Gross Weight Group (custom scheme), 6 = Expansion Factors (custom scheme). Defaults to 2 when omitted. See GET /api/v2/filters/vehicle-class-schemes.	N
`vehicleClasses`	array<object>	vehicleType: string (values: Truck, Passenger, MPV, Bus, Limo, Other, n/a); weightClass: string (values: *, Class 1, Class 2, Class 3, Class 4, Class 5, Class 6, Class 7, Class 8, Class A, Class B, Class C, Class D, Class E, Class F, Class G, Class H)	-	Vehicle class filters. Use an empty array to include all vehicle classes.	N
`vocations`	array<integer>	-	1, 2, 3, 4, 5	Vocation IDs from GET /api/v2/filters/vocations. An empty array includes all vocations.	N
`zoneIds`	array<string>	-	-	Zones to include, as encoded zone IDs. Provide exactly one of zoneIds or zones (not both).	N
`zones`	array<object>	code: string; iso_3166_2: string; type: string (values: State, County, City, FSA, ZIP, TAZ, CTR, Custom)	-	Zones to include, each identified by a code, a zone type and a state or province code (iso_3166_2). Provide exactly one of zones or zoneIds (not both).	N

Examples

County regional domicile request

Translated from the v1 getRegionalDomicileAnalytics sample.

{
  "dateFrom": "2026-01-01",
  "dateTo": "2026-01-31",
  "isMetric": false,
  "zones": [
    {
      "code": "13121",
      "iso_3166_2": "US-GA",
      "type": "County"
    }
  ]
}

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.