Get Trips Stream

This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Trips under the Trips category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Query Params
boolean
Defaults to false

Indicates whether or not to return expanded “asset” data

string
enum
Defaults to all

Filters trips based on a specific completion status Valid values: inProgress, completed, all

Allowed:
string
required

RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against updatedAtTime or tripStartTime depending on the queryBy parameter.

string

RFC 3339 timestamp which is compared against updatedAtTime or tripStartTime depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.

string
enum
Defaults to updatedAtTime

Decide which timestamp the startTime and endTime are compared to. Valid values: updatedAtTime, tripStartTime

Allowed:
string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

ids
array of strings
required

Comma-separated list of asset IDs. Include up to 50 asset IDs.

ids*
Responses

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json