---
title: "[beta] Get custom report datasets"
method: GET
path: "/reports/datasets"
tags: ["Beta APIs"]
---

# \[beta\] Get custom report datasets

`GET /reports/datasets`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/reports/datasets`
- Auth: HTTP bearer

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.

## Query parameters

- `ids` string[]
- `after` string
- `limit` integer

## Response `200`

OK response.

- ReportsGetDatasetsResponseBody
  - `data` ReportsDatasetResponseBody[], required: List of datasets.
    - `displayName` string, required: Display name of the dataset.
    - `fields` ReportsDatasetFieldResponseBody[], required: Fields within the dataset.
      - `dataType` 'string' | 'integer' | 'float' | 'timestamp' | 'unknown', required: Data type of the field. Valid values: `string`, `integer`, `float`, `timestamp`, `unknown`
      - `displayName` string, required: Display name of the field.
      - `name` string, required: Name of the field.
      - `unit` 'amperes' | 'bars' | 'cad' | 'chf' | 'days' | 'decimalDegrees' | 'degreesCelsius' | 'degreesFahrenheit' | 'eur' | 'feet' | 'gForces' | 'gallons' | 'gallonsPerHour' | 'gallonsPerKilogram' | 'gallonsPerMile' | 'gbp' | 'gramsPerLiter' | 'gramsPerMeter' | 'hertz' | 'hours' | 'imperialGallons' | 'imperialGallonsPerHour' | 'imperialGallonsPerKilogram' | 'imperialGallonsPerMile' | 'inches' | 'kelvins' | 'kilograms' | 'kilogramsGaseousFuel' | 'kilogramsPer100KilometerGaseousFuel' | 'kilogramsPerGallon' | 'kilogramsPerKilometer' | 'kilogramsPerLiter' | 'kilogramsPerMile' | 'kilometers' | 'kilometersPerHour' | 'kilometersPerLiter' | 'kilometersPerLiterGaseousFuel' | 'kilopascals' | 'kilowattHours' | 'liters' | 'litersGaseousFuel' | 'litersPer100Kilometers' | 'litersPer100KilometersGaseousFuel' | 'litersPerHour' | 'litersPerKilogram' | 'litersPerKilometer' | 'litersPerMeter' | 'litersPerTonne' | 'meters' | 'metersPerSecond' | 'miles' | 'milesPerGallon' | 'milesPerHour' | 'milesPerImperialGallon' | 'milesPerKilogramGaseousFuel' | 'milesPerUSGallonGaseousFuel' | 'milliknots' | 'milliseconds' | 'millivolts' | 'minutes' | 'months' | 'mxn' | 'percents' | 'pounds' | 'poundsPerGallon' | 'poundsPerLiter' | 'poundsPerMile' | 'poundsPerSquareInch' | 'revolutionsPerMinute' | 'seconds' | 'unknown' | 'usGallonsGaseousFuel' | 'usd' | 'voltAmperes' | 'voltAmperesReactive' | 'volts' | 'wattHours' | 'watts' | 'weeks': Unit of the field. Valid values: `amperes`, `bars`, `cad`, `chf`, `days`, `decimalDegrees`, `degreesCelsius`, `degreesFahrenheit`, `eur`, `feet`, `gForces`, `gallons`, `gallonsPerHour`, `gallonsPerKilogram`, `gallonsPerMile`, `gbp`, `gramsPerLiter`, `gramsPerMeter`, `hertz`, `hours`, `imperialGallons`, `imperialGallonsPerHour`, `imperialGallonsPerKilogram`, `imperialGallonsPerMile`, `inches`, `kelvins`, `kilograms`, `kilogramsGaseousFuel`, `kilogramsPer100KilometerGaseousFuel`, `kilogramsPerGallon`, `kilogramsPerKilometer`, `kilogramsPerLiter`, `kilogramsPerMile`, `kilometers`, `kilometersPerHour`, `kilometersPerLiter`, `kilometersPerLiterGaseousFuel`, `kilopascals`, `kilowattHours`, `liters`, `litersGaseousFuel`, `litersPer100Kilometers`, `litersPer100KilometersGaseousFuel`, `litersPerHour`, `litersPerKilogram`, `litersPerKilometer`, `litersPerMeter`, `litersPerTonne`, `meters`, `metersPerSecond`, `miles`, `milesPerGallon`, `milesPerHour`, `milesPerImperialGallon`, `milesPerKilogramGaseousFuel`, `milesPerUSGallonGaseousFuel`, `milliknots`, `milliseconds`, `millivolts`, `minutes`, `months`, `mxn`, `percents`, `pounds`, `poundsPerGallon`, `poundsPerLiter`, `poundsPerMile`, `poundsPerSquareInch`, `revolutionsPerMinute`, `seconds`, `unknown`, `usGallonsGaseousFuel`, `usd`, `voltAmperes`, `voltAmperesReactive`, `volts`, `wattHours`, `watts`, `weeks`
    - `hasTimeRangeFilter` boolean, required: Indicates if the dataset has a time range filter.
    - `id` string, required: Unique ID of the dataset.
    - `timeRangeLimitDays` integer: Time range limit for the dataset measured in days.
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)