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 API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

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

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

Fetch runs by camera

cURL

curl --request GET \
  --url https://api.samsara.com/v1/industrial/vision/runs/{camera_id} \
  --header 'Authorization: Bearer <token>'

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

camera_id · integer<int64> · required

The camera_id should be valid for the given accessToken.

Query Parameters

durationMs · integer<int64> · required

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

endMs · integer<int64>

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

Response

200

application/json

Return runs by cameraId.

deviceId · integer<int64>

Example:

1234512345123

endedAtMs · integer<int64>

Example:

0

program · object

Show child attributes

reportMetadata · object

Show child attributes

startedAtMs · integer<int64>

Example:

1553808606097