GPS Data Upload Service

API for sending INRIX multiple GPS points (real-time or historical) in a single JSON POST request. The GPS Data Upload Service consumes the uploaded data asynchronously after responding to the POST request. Response times should be approximately 250 milliseconds with the response result referring only to receipt of a data payload and not to the validity of sent data. Providers can make multiple, simultaneous connections to the GPS Data Upload Service using either a single access token or multiple access tokens. The service has required fields (such as lat/lon, anonymous device ID, and timestamp) as well as optional fields.
You must contact INRIX before using optional fields to ensure compliance with privacy standards.

The production endpoint, which should only be used with real data, is: https://appsvc-ingest.inrix.io/v1/gpsdatastream

For testing purposes (including sending test data) the “beta” endpoint is available: https://appsvc-ingest.beta.inrix.io/v1/gpsdatastream

The beta endpoint should not be used for load testing, since it has 10X less capacity.

/v1/gpsdatastream

POST gpsdatastream

Parameters

  = required

Name	Located In	Type	Description
accessToken	Query	String	A valid access token provided from the GET appToken API response. Alternatively, the accesstoken can be added to the request header instead of a url parameter using format 'Authorization: Bearer xxxx.xxx.xxxx'.
Content-Type	Header	String	must be 'application/json'
Content-Encoding	Header	String	use 'gzip' to indicate gzip encoding (optional)
rid	Body	String	A optional unique identifier for the request
dat	Body	Array	Data records. While larger requests are handled, the recommended batch size is 4000-5000 records per request (which will typically be ~1.5MB).
Value Type Description vid string The VehicleID/DeviceID is a unique identifier for the source of the data points. This ID will be anonymized upon receipt by INRIX. ts number The timestamp is the moment when the GPS measurement was made. "Must be a UNIX timestamp in milliseconds since January 1, 1970 at 00:00:00 UTC. For example, March 14, 2015 12:00:00 AM would be 1426291200000" lat double The decimal degrees Latitude. Must be between -90 and 90 degrees. lon double The decimal degrees Longitude. Must be between -180 and 180 degrees. hd number The Heading/Direction in degrees at the moment when the GPS measurement was made. The acceptable values are in the range of 0-360. sp integer The Speed at the moment when the GPS measurement was made. Units defined by the spm field. spm string The Speed Metric in which the speed was recorded. The acceptable values are one of the following MPH (MilesPerHour), KPH (KilometersPerHour), MPS (MetersPerSecond) or KNOTS. ha number Horizontal accuracy other array Array of name-value pairs for sending additional data Value Type Description name string Name of the name/value pair providing additional data value string Value of the name/value pair providing additional data

Requests

Example Datastream Request

Query

https://appsvc-ingest.inrix.io/v1/gpsdatastream?accessToken={token}

Body

{
    "rid": "52f7861c",
    "dat": [
        {
        "vid": "da398a0e3aac34087093c980b7ae3511",
        "ts": 1426291200000,
        "lon": -122.362225,
        "lat": 47.722165,
        "hd": 181.0,
        "sp": 12,
        "spm": "KPH",
        "other": [
            {
            "name": "VehicleType",
            "value": "CargoVan"
            },
            {
            "name": "VehicleWeight",
            "value": "12000"
            }
        ]
        },
        {
        "vid": "da398a0e3aac34087093c980b7ae3511",
        "ts": 1426291350000,
        "lon": -122.362790,
        "lat": 47.722144,
        "hd": 175.0,
        "sp": 17,
        "spm": "KPH",
        "other": [
            {
            "name": "VehicleType",
            "value": "CargoVan"
            },
            {
            "name": "VehicleWeight",
            "value": "12000"
            }
        ]
        }
    ]
}

Responses

200 Success

{
    "result": "ok",
    "copyright": "Copyright INRIX Inc.",
    "createdDate": "2020-06-15T21:06:25.955Z",
    "responseId": "ec34cb98-b605-41a6-9492-dde7aaed3924",
}