queryType: getRegionalDomicileAnalytics*

The getRegionalDomicileAnalytics queryType is used to evaluate vehicle movements roundtrip from a domicile (or place the vehicle resides).

Note:

See Special Case APIs for more information.

The query allows the user to set different eligibility requirements related to the distance of vehicle domicile duty cycles and vehicle domicile stop counts to refine vehicles utilized in the analysis.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose to make an API request.

ParameterDescriptionTypeDefined Value SetValue Req'd
dateRange

An object defining the analysis date range. Each object contains:

  • DateFrom (string) — first date in the analysis date range formatted as "yyyy-mm-dd".

  • DateTo (string) — last date in the analysis date range formatted as "yyyy-mm-dd".

Note:

The maximum date range is one year. For the purposes of determining the domicile for a vehicle, a minimum of one month back from the “DateTo” date is utilized. If the date range exceeds one month, the full date range is used for domicile calculation.

OBJECT-Y
eligibilityCriteria

An object that defines the eligibility criteria to be applied for an analysis. Pass null if you wish to run without eligibility. The object contains:

  • MaxDistanceThreshold (float) — distance threshold (kilometers or miles) used as the benchmark distance that the input PercentileThreshold percentage of a vehicle’s domicile duty cycles distances needs to be less than to be eligible for the analysis.

    Note:

    If you pass this value, you must also pass a PercentileThreshold value.

  • PercentileThreshold (float) — percentage of a vehicle’s domicile duty cycles’ that needs to have a distance less than the input MaxDistanceThreshold in order for a vehicle to be considered eligible, e.g. if the MaxDistanceThreshold is set to 300 miles and the PercentileThreshold is set to 0.85 or 85%, then 85% of domicile duty cycle’s must be 300 miles or less in order for a vehicle to be considered eligible.

  • MinDomicileDutyCycles (integer) — minimum number of domicile duty cycles that a vehicle has to have to be considered eligible.

OBJECT-N
fuelTypesAn array of strings representing the fuel types you want analyzed. Possible values are "Diesel", "Electric", "Flexible", "Gasoline", "Hybrid", "Other" and "Unknown". Refer to the Fuel types table for a description of each option. Can send an empty array to return all fuel types.ARRAYSee Fuel types for a list of fuel types-
isMetricTrue if you want the data returned to be metric, false if you want imperial.BOOLEANtrue or falseY
minDomicileDutyCycleDistance

The minimum distance of a domicile duty cycle for it to be utilized in analysis calculations. Domicile duty cycles shorter than this value will be excluded from the analysis.

Note:

To consider all domicile duty cycles, set this value to 0. The default value for this parameter is 0.

FLOAT-N
minDomicileStopDuration

The minimum stop duration (minutes) at the vehicle’s domicile to be considered a domicile stop and the end of a domicile duty cycle. Domicile stops shorter than this input value are chained to the proceeding trip, thereby ensuring that a domicile duty cycle will only complete when a vehicle stops at its domicile for longer than this value.

Note:

To consider all domicile stops, set this value to 0. The default value for this parameter is 0. See definition of a stop.

INTEGER-N
NAICSAn array of integers representing industry IDs. Can pass an empty array to return data for all industries. To get a list of available industries, use the getIndustries API.ARRAY-N
percentilesArray of integers representing what percentiles you want the metrics broken up into. Default if not provided is [15,85].ARRAY[1-99]N
queryTypeMust equal getRegionalDomicileAnalytics.STRING"getRegionalDomicileAnalytics"Y
vehicleClasses

An array of vehicle class objects where each object contains VehicleType and WeightClass. To get the list of possible vehicle types and weight classes, refer to Vehicle types and Weight class tables. If a vehicle type does not have any weight classes listed, just pass "*". More information on vehicle classes can be found at AFDC Vehicle Categories. To get all vehicle classes returned, pass an empty array.

ARRAY

See the Vehicle types and Weight class tables.

For Vehicle Type: "Truck", "Passenger", "MPV", "Bus", "Other". More information at AFDC Vehicle Categories.

To get all vehicle types, pass an empty array.

N
vehicleClassSchemeIdDetermines which vehicle classification scheme you will receive data for. See the Vehicle class schemas for a list of options. The default value is 2.INTEGER[1,4]N
vocationsAn array of integers representing vocation IDs for vocations of interest. Can pass specific IDs or an empty array to return data for all vocations.ARRAYSee Vocation descriptions for a list of vocation IDs and their mapping information.N
zones

An array of objects representing the zones for which you want information. Each object contains ZoneId, ISO_3166_2, and ZoneType:

  • ZoneId (string) — A custom zone ID or a standard zone ID such as county ID, city ID, etc.

  • ISO_3166_2 (string) — The ISO code of the standard zone. Does not apply to custom zones and can be set to null.

  • ZoneType (string) — the type of zone.

ARRAY

  • ZoneType - “Custom”

  • “State”

  • “County”

  • “City”

  • “TAZ”

  • “ZIP”

  • “CTR”

  • “FSA”.

See Zones for details on how to structure the zone inputs for each zone type.

Y

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks, such as not providing credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact Altitude Support if this occurs.

Response Schema

AttributeDescriptionData TypeDefined Value Set
DomDCCountTotal 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.INTEGER-
DomDCDistanceAvgThe average domicile duty cycle distance (kilometers or miles).FLOAT-
DomDCDistanceMedThe median domicile duty cycle distance (kilometers or miles).FLOAT-
DomDCDistancePercentiles

Array of objects representing percentile domicile duty cycle distance values for input percentiles. Each object contains:

  • Percentile (integer): the percentile value.

  • Value (float): the calculated percentile domicile duty cycle distance (kilometers or miles).

Note:

If no percentiles are input, the 15th and 85th percentiles are provided by default. Percentiles will only be provided if there are sufficient records to calculate the requested percentiles.

ARRAY-
DomDCDistanceStdevThe standard deviation of domicile duty cycle distance (kilometers or miles).FLOAT-
DomDCDurationAvgThe average domicile duty cycle duration (minutes).FLOAT-
DomDCDurationMedThe median domicile duty cycle duration (minutes).FLOAT-
DomDCDurationPercentiles

Array of objects representing percentile domicile duty cycle duration values for input percentiles. Each object contains:

  • Percentile (integer): the percentile value.

  • Value (float): the calculated percentile domicile duty cycle duration (minutes).

Note:

If no percentiles are input, the 15th and 85th percentiles are provided by default. Percentiles will only be provided if there are sufficient records to calculate the requested percentiles.

ARRAY-
DomDCDurationStdevThe standard deviation of domicile duty cycle duration (minutes).FLOAT-
DomMetricsByDayOfWeek

Array of objects representing domicile metrics for a day of week, based on domicile duty cycles that stop at their domicile during the day of the week (local time).

Note:

Exception on StoppedAtDomPct, StoppedAtNonDomPct and DrivingPct, which show the total percentage of activity across eligible vehicle for the day of the week.

Each object contains:

  • DayOfWeek (integer) — the day of the week.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles that stop at their domicile during the day of week across the entire analysis period.

  • EligibleDomVehicleCountAvg (integer) — average number of eligible vehicles that stop at their domicile during a single instance of the day of week.

  • EligibleDomVehicleCountMed (integer) — median number of eligible vehicles that stop at their domicile during a single instance of the day of week.

  • DomDCCount (integer) — number of domicile duty cycles that stop at their domicile during this day of week, across the entire analysis period.

  • DomDCCountAvg (integer) — average number of domicile duty cycles that stop at their domicile during a single instance of the day of week.

  • DomDCCountMed (integer) — median number of domicile duty cycles that stop at their domicile during a single instance of the day of week.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles that stop at their domicile on the day of week.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles that stop at their domicile on the day of week.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop on the day of week.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop on the day of week.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles that stop at their domicile on the day of week.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles that stop at their domicile on the day of week.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile on the day of week.

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile on the day of week.

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile on the day of week.

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile on the day of week.

  • StoppedAtDomPct (float) — the total percentage of activity on the day of week that can be attributed to a vehicle being stopped at their domicile. Calculated across the analysis date range and all eligible vehicles.

  • StoppedAtNonDomPct (float) — the total percentage of activity on the day of week that can be attributed to a vehicle being stopped at a non domicile. Calculated across the analysis date range and all eligible vehicles.

  • DrivingPct (float) — the total percentage of activity on the day of week that can be attributed to a vehicle driving. Calculated across the analysis date range and all eligible vehicles.

ARRAYDayOfWeek = [1:7], where 1 = Sunday and 7 = Saturday.
DomMetricsByFuelType

Array of objects representing domicile metrics for each fuel type. Each object contains:

  • FuelType (string) — fuel type name.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles.

  • DomDCCount (integer) — number of domicile duty cycles.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles).

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles).

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes).

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes).

ARRAY-
DomMetricsByHour

Array of objects representing domicile metrics for an hour, based on domicile duty cycles that stop at their domicile during the hour (local time).

Note:

Exception on StoppedAtDomPct, StoppedAtNonDomPct and DrivingPct, which show the total percentage of activity across eligible vehicle for the hour).

Each object contains:

  • Hour (integer) — the hour.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles that stop at their domicile during the hour across the entire analysis period.

  • EligibleDomVehicleCountAvg (integer) — average number of eligible vehicles that stop at their domicile during a single instance of the hour.

  • EligibleDomVehicleCountMed (integer) — median number of eligible vehicles that stop at their domicile during a single instance of the hour.

  • DomDCCount (integer) — number of domicile duty cycles that stop at their domicile during this hour, across the entire analysis period.

  • DomDCCountAvg (integer) — average number of domicile duty cycles that stop at their domicile during a single instance of the hour.

  • DomDCCountMed (integer) — median number of domicile duty cycles that stop at their domicile during a single instance of the hour.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles that stop at their domicile during the hour.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles that stop at their domicile during the hour.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop during the hour.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop during the hour.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles that stop at their domicile during the hour.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles that stop at their domicile during the hour.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile during the hour.

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile during the hour.

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile during the hour.

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile during the hour.

  • StoppedAtDomPct (float) — the total percentage of activity during the hour that can be attributed to a vehicle being stopped at their domicile. Calculated across the analysis date range and all eligible vehicles.

  • StoppedAtNonDomPct (float) — the total percentage of activity during the hour that can be attributed to a vehicle being stopped at a non domicile. Calculated across the analysis date range and all eligible vehicles.

  • DrivingPct (float) — the total percentage of activity during the hour that can be attributed to a vehicle driving. Calculated across the analysis date range and all eligible vehicles.

ARRAYHour — [0:23]
DomMetricsByIndustry

Array of objects representing domicile metrics for each NAICS code 1. Each object contains:

  • NAICS_Code_1 (integer) — NAICS code 1.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles.

  • DomDCCount (integer) — number of domicile duty cycles.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles).

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles).

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes).

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes).

ARRAY-
DomMetricsByMonth

Array of objects representing domicile metrics for a month, based on domicile duty cycles that stop at their domicile during the month (local time).

Note:

Exception on StoppedAtDomPct, StoppedAtNonDomPct and DrivingPct, which show the total percentage of activity across eligible vehicle for the hour).

Each object contains:

  • Month (integer) — the month.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles that stop at their domicile during the month across the entire analysis period.

  • EligibleDomVehicleCountAvg (integer) — average number of eligible vehicles that stop at their domicile during a single instance of the month.

  • EligibleDomVehicleCountMed (integer) — median number of eligible vehicles that stop at their domicile during a single instance of the month.

  • DomDCCount (integer) — number of domicile duty cycles that stop at their domicile during this month, across the entire analysis period.

  • DomDCCountAvg (integer) — average number of domicile duty cycles that stop at their domicile during a single instance of the month.

  • DomDCCountMed (integer) — median number of domicile duty cycles that stop at their domicile during a single instance of the month.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles that stop at their domicile during the month.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles that stop at their domicile during the month.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop during the month.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle, for domicile duty cycles that stop during the month.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles that stop at their domicile during the month.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles that stop at their domicile during the month.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile during the month.

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles) for domicile duty cycles that stop at their domicile during the month.

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile during the month.

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes) for domicile duty cycles that stop at their domicile during the month.

  • StoppedAtDomPct (float) — the total percentage of activity during the month that can be attributed to a vehicle being stopped at their domicile. Calculated across the analysis date range and all eligible vehicles.

  • StoppedAtNonDomPct (float) — the total percentage of activity during the month that can be attributed to a vehicle being stopped at a non domicile. Calculated across the analysis date range and all eligible vehicles.

  • DrivingPct (float) — the total percentage of activity during the month that can be attributed to a vehicle driving. Calculated across the analysis date range and all eligible vehicles.

ARRAYMonth — [1:12]
DomMetricsByVehicleClass

Array of objects representing domicile metrics for each vehicle class. Each object contains:

  • SchemeId (integer) — vehicle class scheme identifier.

  • CategoryIndex (integer) — vehicle class category identifier.

  • VehicleClassIndex (integer) — vehicle class identifier.

  • VehicleClass (string) — vehicle class name.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles.

  • DomDCCount (integer) — number of domicile duty cycles.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles).

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles).

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes).

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes).

ARRAY-
DomMetricsForVehicleDailyDC

An object representing metrics around the average daily domicile duty cycle for a vehicle. The object contains:

  • OperatingDaysAvg (integer) — average number of operating days (days a vehicle travels 2 or more miles) for a vehicle.

  • OperatingDaysMed (integer) — median number of operating days (days a vehicle travels 2 or more miles) for a vehicle.

  • DailyDomDCCountAvg (integer) — average number of daily domicile duty cycles for a vehicle.

  • DailyDomDCCountMed (integer) — median number of daily domicile duty cycles for a vehicle.

  • DailyDomStopDurationAvg (float) — average amount of time (minutes) a vehicle spends stopped at its domicile daily.

  • DailyDomStopDurationMed (float) — the median amount of time (minutes) a vehicle spends stopped at its domicile daily.

  • DailyNonDomStopCountAvg (integer) — average number of daily non-domicile stops.

  • DailyNonDomStopCountMed (integer) — median number of daily non-domicile stops.

  • DailyNonDomStopDurationAvg (float) — average amount of time (minutes) a vehicle spends stopped at non-domicile locations daily.

  • DailyNonDomStopDurationMed (float) — median amount of time (minutes) a vehicle spends stopped at non-domicile locations daily.

  • DailyDriveDistanceAvg (float) — average estimated daily drive distance (km or miles) for a vehicle.

  • DailyDriveDistanceMed (float) — median estimated daily drive distance (km or miles) for a vehicle.

  • DailyDriveDurationAvg (float) — average daily drive duration (minutes) for a vehicle.

  • DailyDriveDurationMed (float) — median daily drive duration (minutes) for a vehicle.

ARRAY-
DomMetricsByVocation

Array of objects representing domicile metrics for each vocation. Each object contains:

  • VocationId (integer) — unique identifier for the vocation.

  • Vocation (string) — vocation name.

  • EligibleDomVehicleCount (integer) — number of eligible vehicles.

  • DomDCCount (integer) — number of domicile duty cycles.

  • DomStopDurationAvg (float) — average domicile stop duration (minutes) of domicile duty cycles.

  • DomStopDurationMed (float) — median domicile stop duration (minutes) of domicile duty cycles.

  • NonDomStopsPerDomDCAvg (integer) — average number of non-domicile stops during a domicile duty cycle.

  • NonDomStopsPerDomDCMed (integer) — median number of non-domicile stops during a domicile duty cycle.

  • NonDomStopDurationAvg (float) — average non-domicile stop duration during domicile duty cycles.

  • NonDomStopDurationMed (float) — median non-domicile stop duration during domicile duty cycles.

  • DomDCDistanceAvg (float) — average domicile duty cycle distance (km or miles).

  • DomDCDistanceMed (float) — median domicile duty cycle distance (km or miles).

  • DomDCDurationAvg (float) — average domicile duty cycle duration (minutes).

  • DomDCDurationMed (float) — median domicile duty cycle duration (minutes).

ARRAY-
DomStopDurationAvgThe average domicile stop duration (minutes).FLOAT-
DomStopDurationMedThe median domicile stop duration (minutes).FLOAT-
DomStopDurationPercentiles

Array of objects representing percentile domicile stop duration values for input percentiles. Each object contains:

  • Percentile (integer): the percentile value.

  • Value (float): the calculated percentile domicile stop duration value (minutes).

Note:

If no percentiles are input, the 15th and 85th percentiles are provided by default. Percentiles will only be provided if there are sufficient records to calculate the requested percentiles.

ARRAY-
DomStopDurationStdevThe standard deviation of domicile stop duration (minutes).FLOAT-
EligibleDomVehicleCountThe 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.INTEGER-
ISO_3166_2Unique ISO 3166-2 identifier representing the state/provincial code of the region.STRING-
NonDomStopDurationAvgThe average stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle.FLOAT-
NonDomStopDurationMedThe median stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle.FLOAT-
NonDomStopDurationPercentiles

Array of objects representing percentile non domicile stop duration values for input percentiles. Each object contains:

  • Percentile (integer): the percentile value.

  • Value (float): the calculated percentile non domicile stop duration value (minutes).

Note:

If no percentiles are input, the 15th and 85th percentiles are provided by default. Percentiles will only be provided if there are sufficient records to calculate the requested percentiles.

ARRAY-
NonDomStopDurationStdevThe standard deviation of stop duration (minutes) for stops made at non-domiciles during a domicile duty cycle.FLOAT-
NonDomStopsPerDomDCAvgThe average number of non-domicile stops per domicile duty cycle.INTEGER-
NonDomStopsPerDomDCMedThe median number of non-domicile stops per domicile duty cycle.INTEGER-
NonDomStopsPerDomDCPercentiles

Array of objects representing percentile non domicile stops per domicile duty cycle values for input percentiles. Each object contains:

  • Percentile (integer): the percentile value.

  • Value (integer): the calculated percentile non domicile stops per domicile duty cycle value.

Note:

If no percentiles are input, the 15th and 85th percentiles are provided by default. Percentiles will only be provided if there are sufficient records to calculate the requested percentiles.

ARRAY-
NonDomStopsPerDomDCStdevThe standard deviation of non-domicile stops per domicile duty cycle.INTEGER-
TotalDomVehicleCountThe number of vehicles that meet vehicle filters and have their domicile within the zone.INTEGER-
ZoneDescription

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.

STRING-
ZoneIdThe zone ID for which data is being returned.STRING-
ZoneTypeThe zone type of the zone.STRING[“Custom”, ”State”, ”County”, City”, ”ZIP”, “CTR”,“FSA”, “TAZ]

Sample parameters

{
	"queryType": "getRegionalDomicileAnalytics",
	"dateRange": {
	"DateFrom": "2022-04-15",
	"DateTo": "2022-04-30"
},
"eligibilityCriteria":{
	"MaxDistanceThreshold": 300,
	"PercentileThreshold": 0.95,
	"MinDomicileDutyCycles": 2
	},
"isMetric": false,
"minDomicileDutyCycleDistance": 2,
"minDomicileStopDuration": 30,
"percentiles": [10,20,30,40,50,60,70,80,90],
"vehicleClassSchemeId": 2,
"zones": [{
	"ZoneId": "32003",
	"ISO_3166_2": "US-NV",
	"ZoneType": "County"
	}]
}