Skip to main content

​
Field Coverage

The percentage of connections across all providers that have data populated for each field.
FieldCoverage
distance100%
id100%
jurisdiction100%
month100%
provider100%
vehicle100%
​
id
string<ulid>
required
Example:

"ifta_rpt_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

​
vehicle
required

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

Pattern: ^vcl_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
month
string
required

ISO 8601 month

Pattern: ^(\d{4})-(0[1-9]|1[0-2])$
Example:

"2021-01"

​
jurisdiction
null | enum<string>
required

US State or Canadian Province

Available options:
AL,
AK,
AS,
AZ,
AR,
CA,
CO,
CT,
DE,
FL,
GA,
GU,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MP,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
VI,
AB,
BC,
MB,
NB,
NL,
NS,
ON,
PE,
QC,
SK,
NT,
NU,
UM,
YT,
DC
Example:

"TN"

​
distance
number
required

Distance in kilometers

Example:

100

​
metadata
EntityMetadata · object
required

Internal metadata about the record.

​
raw
RawData · object[]
Example:
[]