SAsamsara
Industrial

Fetch runs by camera

🚧 This endpoint is still on our legacy API.

Fetch runs by camera.

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.

To use this endpoint, select Read Industrial under the Industrial 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>

get/v1/industrial/vision/runs/{camera_id}

Request

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

Path parameters

camera_idinteger required

The camera_id should be valid for the given accessToken.

Query parameters

durationMsinteger required

DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched

endMsinteger

EndMs is an optional param. It will default to the current time.

Response

Return runs by cameraId.

deviceIdinteger
endedAtMsinteger
startedAtMsinteger

Example response

[
  {
    "deviceId": 1234512345123,
    "program": {
      "id": 1,
      "name": "Barcode verification program"
    },
    "reportMetadata": {
      "itemsPerMinute": 0.1,
      "successCount": 181
    },
    "startedAtMs": 1553808606097
  }
]

Changes

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