SAsamsara
Trips

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.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Trips under the Trips category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/trips/stream

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

includeAssetboolean

Indicates whether or not to return expanded “asset” data

completionStatus'inProgress' | 'completed' | 'all'

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

startTimestring required

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

endTimestring

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.

queryBy'updatedAtTime' | 'tripStartTime'

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

afterstring

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.

idsstring[] required

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

Response

OK response.

Example response

{
  "data": [
    {
      "asset": {
        "id": "12345",
        "name": "MyAsset-1234",
        "type": "trailer",
        "vin": "1GBJ6P1B2HV112765"
      },
      "completionStatus": "completed",
      "createdAtTime": "2024-04-16T19:08:25Z",
      "endLocation": {
        "accuracyMeters": 5.801,
        "address": {
          "city": "New York",
          "country": "USA",
          "neighborhood": "Mission District",
          "pointOfInterest": "The Eiffel Tower",
          "postalCode": "10010",
          "state": "New York",
          "street": "Main Street",
          "streetNumber": "16"
        },
        "geofence": {
          "id": "12345"
        },
        "headingDegrees": 120,
        "latitude": 37.7749,
        "longitude": 137.2719
      },
      "finalDistanceMeters": 2500,
      "startLocation": {
        "accuracyMeters": 5.801,
        "address": {
          "city": "New York",
          "country": "USA",
          "neighborhood": "Mission District",
          "pointOfInterest": "The Eiffel Tower",
          "postalCode": "10010",
          "state": "New York",
          "street": "Main Street",
          "streetNumber": "16"
        },
        "geofence": {
          "id": "12345"
        },
        "headingDegrees": 120,
        "latitude": 37.7749,
        "longitude": 137.2719
      },
      "tripEndTime": "2024-04-16T20:00:00Z",
      "tripPurpose": "business",
      "tripStartTime": "2024-04-16T19:08:25Z",
      "updatedAtTime": "2024-04-16T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.