Beta APIs

[beta] Get custom report datasets

Get datasets for custom reports.

<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/datasets

Request

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

Query parameters

idsstring[]

The list of dataset IDs to retrieve the datasets for. Include up to 10 dataset IDs. If not provided, all datasets will be returned.

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 datasets to return.

Response

OK response.

Example response

{
  "data": [
    {
      "displayName": "Assets",
      "fields": [
        {
          "dataType": "string",
          "displayName": "Asset: Name",
          "name": "Name",
          "unit": "kilometersPerHour"
        }
      ],
      "hasTimeRangeFilter": true,
      "id": "Assets",
      "timeRangeLimitDays": 31
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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