SAsamsara
Maintenance

Stream DVIRs

Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing endTime parameter it will return a never ending stream of data.

<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 DVIRs under the Maintenance 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/dvirs/stream

Request

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

Query parameters

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.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 200 objects.

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

startTimestring required

Required RFC 3339 timestamp to begin the feed or history by updatedAtTime at startTime.

endTimestring

Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.

safetyStatusstring[]

Optional list of safety statuses. Valid values: [safe, unsafe, resolved]

Response

OK response.

Example response

{
  "data": [
    {
      "authorSignature": {
        "signatoryUser": {
          "id": "938172"
        },
        "signedAtTime": "2020-01-27T07:06:25Z",
        "type": "driver"
      },
      "defectIds": [
        "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596",
        "25d6151e-29b5-453e-875a-7c5425332e09"
      ],
      "dvirSubmissionBeginTime": "2020-01-27T07:06:25Z",
      "dvirSubmissionTime": "2020-01-27T07:06:25Z",
      "formattedAddress": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103",
      "id": "12345",
      "mechanicNotes": "Replaced headlight on passenger side.",
      "odometerMeters": 91823,
      "safetyStatus": "unsafe",
      "secondSignature": {
        "signatoryUser": {
          "id": "938172"
        },
        "signedAtTime": "2020-01-27T07:06:25Z",
        "type": "driver"
      },
      "thirdSignature": {
        "signatoryUser": {
          "id": "938172"
        },
        "signedAtTime": "2020-01-27T07:06:25Z",
        "type": "driver"
      },
      "trailer": {
        "id": "494123"
      },
      "type": "mechanic",
      "updatedAtTime": "2020-01-27T07:06:25Z",
      "vehicle": {
        "id": "494123"
      },
      "walkaroundPhotos": [
        {
          "createdAtTime": "2020-01-27T07:06:25Z",
          "name": "Name 1",
          "url": "https://s3.samsara.com/samsara-driver-media-upload/walkaround-photo-path"
        }
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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