/** * Samsara API * # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.

Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).

*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*

Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures). * * The version of the OpenAPI document: 2024-11-18 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information about a custom report column. * @export * @interface CustomReportColumnsObjectResponseBody */ export interface CustomReportColumnsObjectResponseBody { /** * [deprecated] Use unit instead. Valid values: `bar`, `celsius`, `fahrenheit`, `foot`, `gallon`, `galpermi`, `gforce`, `gperliter`, `gperm`, `impgallon`, `impgalpermi`, `inch`, `kelvin`, `kgpergallon`, `kgperkm`, `kgperliter`, `kgpermi`, `kilogram`, `kilometer`, `kilopascal`, `kilowatthour`, `kmperhr`, `lbpermi`, `liter`, `lper100km`, `lperkm`, `lperm`, `meter`, `meterspersec`, `mile`, `milliknot`, `milliseconds`, `millivolt`, `mipergal`, `miperhr`, `miperimpgal`, `pound`, `poundsPerSquareInch`, `poundspergallon`, `poundsperliter`, `volt`, `watthour` * @type {string} * @memberof CustomReportColumnsObjectResponseBody */ 'baseUnit'?: CustomReportColumnsObjectResponseBodyBaseUnitEnum; /** * The display name of the column that appears in the dashboard or exported csv, xlsx, and pdf reports. This value can contain whitespaces and special characters. It is not used to key the values below in the `data` array. * @type {string} * @memberof CustomReportColumnsObjectResponseBody */ 'displayName': string; /** * The type of data for this column. Valid values: `string`, `numeric` * @type {string} * @memberof CustomReportColumnsObjectResponseBody */ 'type': CustomReportColumnsObjectResponseBodyTypeEnum; /** * The unit of the data for this column. If the data is a string or custom score (ie, anticipation score), unit will not be returned. Valid values: `bar`, `degreesCelsius`, `degreesFahrenheit`, `feet`, `gForces`, `gallons`, `gallonsPerMile`, `gramsPerLiter`, `gramsPerMeter`, `imperialGallons`, `imperialGallonsPerMile`, `inches`, `kelvin`, `kilograms`, `kilogramsPerGallon`, `kilogramsPerKilometer`, `kilogramsPerLiter`, `kilogramsPerMile`, `kilometers`, `kilometersPerHour`, `kilopascals`, `kilowattHours`, `liters`, `litersPer100Kilometers`, `litersPerKilometer`, `litersPerMeter`, `meters`, `metersPerSecond`, `miles`, `milesPerGallon`, `milesPerHour`, `milesPerImperialGallon`, `milliknots`, `milliseconds`, `millivolts`, `pounds`, `poundsPerGallon`, `poundsPerLiter`, `poundsPerMile`, `poundsPerSquareInch`, `volts`, `wattHours` * @type {string} * @memberof CustomReportColumnsObjectResponseBody */ 'unit'?: CustomReportColumnsObjectResponseBodyUnitEnum; } export declare const CustomReportColumnsObjectResponseBodyBaseUnitEnum: { readonly Bar: "bar"; readonly Celsius: "celsius"; readonly Fahrenheit: "fahrenheit"; readonly Foot: "foot"; readonly Gallon: "gallon"; readonly Galpermi: "galpermi"; readonly Gforce: "gforce"; readonly Gperliter: "gperliter"; readonly Gperm: "gperm"; readonly Impgallon: "impgallon"; readonly Impgalpermi: "impgalpermi"; readonly Inch: "inch"; readonly Kelvin: "kelvin"; readonly Kgpergallon: "kgpergallon"; readonly Kgperkm: "kgperkm"; readonly Kgperliter: "kgperliter"; readonly Kgpermi: "kgpermi"; readonly Kilogram: "kilogram"; readonly Kilometer: "kilometer"; readonly Kilopascal: "kilopascal"; readonly Kilowatthour: "kilowatthour"; readonly Kmperhr: "kmperhr"; readonly Lbpermi: "lbpermi"; readonly Liter: "liter"; readonly Lper100km: "lper100km"; readonly Lperkm: "lperkm"; readonly Lperm: "lperm"; readonly Meter: "meter"; readonly Meterspersec: "meterspersec"; readonly Mile: "mile"; readonly Milliknot: "milliknot"; readonly Milliseconds: "milliseconds"; readonly Millivolt: "millivolt"; readonly Mipergal: "mipergal"; readonly Miperhr: "miperhr"; readonly Miperimpgal: "miperimpgal"; readonly Pound: "pound"; readonly PoundsPerSquareInch: "poundsPerSquareInch"; readonly Poundspergallon: "poundspergallon"; readonly Poundsperliter: "poundsperliter"; readonly Volt: "volt"; readonly Watthour: "watthour"; }; export type CustomReportColumnsObjectResponseBodyBaseUnitEnum = typeof CustomReportColumnsObjectResponseBodyBaseUnitEnum[keyof typeof CustomReportColumnsObjectResponseBodyBaseUnitEnum]; export declare const CustomReportColumnsObjectResponseBodyTypeEnum: { readonly String: "string"; readonly Numeric: "numeric"; }; export type CustomReportColumnsObjectResponseBodyTypeEnum = typeof CustomReportColumnsObjectResponseBodyTypeEnum[keyof typeof CustomReportColumnsObjectResponseBodyTypeEnum]; export declare const CustomReportColumnsObjectResponseBodyUnitEnum: { readonly Bar: "bar"; readonly DegreesCelsius: "degreesCelsius"; readonly DegreesFahrenheit: "degreesFahrenheit"; readonly Feet: "feet"; readonly GForces: "gForces"; readonly Gallons: "gallons"; readonly GallonsPerMile: "gallonsPerMile"; readonly GramsPerLiter: "gramsPerLiter"; readonly GramsPerMeter: "gramsPerMeter"; readonly ImperialGallons: "imperialGallons"; readonly ImperialGallonsPerMile: "imperialGallonsPerMile"; readonly Inches: "inches"; readonly Kelvin: "kelvin"; readonly Kilograms: "kilograms"; readonly KilogramsPerGallon: "kilogramsPerGallon"; readonly KilogramsPerKilometer: "kilogramsPerKilometer"; readonly KilogramsPerLiter: "kilogramsPerLiter"; readonly KilogramsPerMile: "kilogramsPerMile"; readonly Kilometers: "kilometers"; readonly KilometersPerHour: "kilometersPerHour"; readonly Kilopascals: "kilopascals"; readonly KilowattHours: "kilowattHours"; readonly Liters: "liters"; readonly LitersPer100Kilometers: "litersPer100Kilometers"; readonly LitersPerKilometer: "litersPerKilometer"; readonly LitersPerMeter: "litersPerMeter"; readonly Meters: "meters"; readonly MetersPerSecond: "metersPerSecond"; readonly Miles: "miles"; readonly MilesPerGallon: "milesPerGallon"; readonly MilesPerHour: "milesPerHour"; readonly MilesPerImperialGallon: "milesPerImperialGallon"; readonly Milliknots: "milliknots"; readonly Milliseconds: "milliseconds"; readonly Millivolts: "millivolts"; readonly Pounds: "pounds"; readonly PoundsPerGallon: "poundsPerGallon"; readonly PoundsPerLiter: "poundsPerLiter"; readonly PoundsPerMile: "poundsPerMile"; readonly PoundsPerSquareInch: "poundsPerSquareInch"; readonly Volts: "volts"; readonly WattHours: "wattHours"; }; export type CustomReportColumnsObjectResponseBodyUnitEnum = typeof CustomReportColumnsObjectResponseBodyUnitEnum[keyof typeof CustomReportColumnsObjectResponseBodyUnitEnum];