SAsamsara
Issues

Get a stream of filtered issues.

Returns all issues data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.

<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 Issues under the Forms 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/issues/stream

Request

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

Query parameters

startTimestring required

A start time in RFC 3339 format. Millisecond precision and timezones are supported. Value is compared against updatedAtTime. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

endTimestring

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Value is compared against updatedAtTime. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

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.

statusstring[]

A comma-separated list containing status values to filter issues on. Valid values: open, inProgress, resolved, dismissed

assetIdsstring[]

A comma-separated list containing up to 50 asset IDs to filter issues on. Each value can be a Samsara asset ID, an external ID (key:value format), or the literal untracked to include issues with untracked assets.

assetExternalIdsstring[]

A comma-separated list containing up to 50 asset external IDs (key:value format) to filter issues on.

includestring[]

A comma separated list of additional fields to include on requested objects. Valid values: externalIds

assignedToRouteStopIdsstring[]

A comma-separated list containing up to 50 route stop IDs to filter data on.

Response

OK response.

Example response

{
  "data": [
    {
      "asset": {
        "entryType": "tracked",
        "id": "281474982859091",
        "name": "trailer 123"
      },
      "assignedTo": {
        "id": "938172",
        "type": "driver"
      },
      "createdAtTime": "2019-06-13T19:08:25Z",
      "description": "Oil spill in left corner of SF1",
      "dueDate": "2019-06-13T19:08:25Z",
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "issueSource": {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "type": "form"
      },
      "mediaList": [
        {
          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
          "processingStatus": "processing",
          "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
          "urlExpiresAt": "2019-06-13T19:08:25Z"
        }
      ],
      "priority": "high",
      "status": "open",
      "submittedAtTime": "2019-06-13T19:08:25Z",
      "submittedBy": {
        "id": "938172",
        "type": "driver"
      },
      "title": "Oil spill",
      "updatedAtTime": "2019-06-13T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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