Beta APIs

[beta] Get custom report run data

Get data for the given custom report run.

<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 Custom Reports under the Custom Reports 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/reports/runs/data

Request

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

Query parameters

idstring required

ID of the report run.

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

Maximum number of rows to return.

Response

OK response.

Example response

{
  "data": {
    "columns": [
      {
        "dataType": "string",
        "name": "Device Name",
        "unit": "kilometersPerHour"
      }
    ],
    "rows": [
      [
        "Dignissimos iusto quae pariatur vel non.",
        "Porro corporis ipsum.",
        "Eos doloribus omnis dolor."
      ],
      [
        "Natus consequatur ad a.",
        "Sit tempora.",
        "Reiciendis quo assumenda.",
        "Fugit ab ut nobis dolorem cupiditate eos."
      ],
      [
        "Voluptatibus placeat qui impedit et et ut.",
        "Necessitatibus vel voluptas nobis at dignissimos.",
        "Officia aut qui et.",
        "Dolores nobis quia voluptas mollitia officiis."
      ]
    ],
    "status": "complete"
  },
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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