/** * 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. */ import { CoachableEventResponseBody } from './coachable-event-response-body'; /** * Object reference for the behavior within the session. * @export * @interface BehaviorResponseBody */ export interface BehaviorResponseBody { /** * Coachable behavior type for the behavior in the coaching session. Valid values: `acceleration`, `braking`, `cameraObstruction`, `crash`, `defensiveDriving`, `didNotYield`, `drinkPolicy`, `drowsy`, `eatingDrinking`, `event`, `falsePositive`, `foodPolicy`, `forwardCollisionWarning`, `genericDistraction`, `harshTurn`, `hosViolation`, `idling`, `laneDeparture`, `lateResponse`, `maskPolicy`, `maxSpeed`, `mobileUsage`, `nearCollison`, `noSeatbelt`, `obstructedCamera`, `outwardObstruction`, `passengerPolicy`, `ranRedLight`, `rollingRailroadCrossing`, `rollingStop`, `rollingStop`, `rollover`, `rolloverProtection`, `rolloverProtectionBrakeControlActivated`, `rolloverProtectionEngineControlActivated`, `severeSpeeding`, `smoking`, `speeding`, `tailgating`, `unknown`, `yawControl`, `yawControlBrakeControlActivated`, `yawControlEngineControlActivated` * @type {string} * @memberof BehaviorResponseBody */ 'coachableBehaviorType': BehaviorResponseBodyCoachableBehaviorTypeEnum; /** * Object references for the coachableEvents within the behavior. Returned when includeCoachableEvents is \'true\'. Capped at 100 coachable events per Coaching session. For sessions where coachable events exceed 100, please visit the Samsara dashboard to address this coaching session. Corresponds to the following unique identifiers: Non-Speeding Safety events - unique Samsara ID of the safety event as \'vehicleId - eventMS\'. Speeding events - unique UUID of the event. Day of HOS Violations - unique Samsara ID of the day of violations as \'{driverId},{date}\'. Idling events - unique UUID of the event. * @type {Array} * @memberof BehaviorResponseBody */ 'coachableEvents'?: Array; /** * Unique ID for the coaching behavior. * @type {string} * @memberof BehaviorResponseBody */ 'id': string; /** * Time of last coached date for the same behavior label. * @type {string} * @memberof BehaviorResponseBody */ 'lastCoachedTime': string; /** * Associated note for the coaching behavior. Returned when present. * @type {string} * @memberof BehaviorResponseBody */ 'note'?: string; /** * Time of coaching behavior update in UTC. * @type {string} * @memberof BehaviorResponseBody */ 'updatedAtTime': string; } export declare const BehaviorResponseBodyCoachableBehaviorTypeEnum: { readonly Acceleration: "acceleration"; readonly Braking: "braking"; readonly CameraObstruction: "cameraObstruction"; readonly Crash: "crash"; readonly DefensiveDriving: "defensiveDriving"; readonly DidNotYield: "didNotYield"; readonly DrinkPolicy: "drinkPolicy"; readonly Drowsy: "drowsy"; readonly EatingDrinking: "eatingDrinking"; readonly Event: "event"; readonly FalsePositive: "falsePositive"; readonly FoodPolicy: "foodPolicy"; readonly ForwardCollisionWarning: "forwardCollisionWarning"; readonly GenericDistraction: "genericDistraction"; readonly HarshTurn: "harshTurn"; readonly HosViolation: "hosViolation"; readonly Idling: "idling"; readonly LaneDeparture: "laneDeparture"; readonly LateResponse: "lateResponse"; readonly MaskPolicy: "maskPolicy"; readonly MaxSpeed: "maxSpeed"; readonly MobileUsage: "mobileUsage"; readonly NearCollison: "nearCollison"; readonly NoSeatbelt: "noSeatbelt"; readonly ObstructedCamera: "obstructedCamera"; readonly OutwardObstruction: "outwardObstruction"; readonly PassengerPolicy: "passengerPolicy"; readonly RanRedLight: "ranRedLight"; readonly RollingRailroadCrossing: "rollingRailroadCrossing"; readonly RollingStop: "rollingStop"; readonly RollingStop2: "rollingStop"; readonly Rollover: "rollover"; readonly RolloverProtection: "rolloverProtection"; readonly RolloverProtectionBrakeControlActivated: "rolloverProtectionBrakeControlActivated"; readonly RolloverProtectionEngineControlActivated: "rolloverProtectionEngineControlActivated"; readonly SevereSpeeding: "severeSpeeding"; readonly Smoking: "smoking"; readonly Speeding: "speeding"; readonly Tailgating: "tailgating"; readonly Unknown: "unknown"; readonly YawControl: "yawControl"; readonly YawControlBrakeControlActivated: "yawControlBrakeControlActivated"; readonly YawControlEngineControlActivated: "yawControlEngineControlActivated"; }; export type BehaviorResponseBodyCoachableBehaviorTypeEnum = typeof BehaviorResponseBodyCoachableBehaviorTypeEnum[keyof typeof BehaviorResponseBodyCoachableBehaviorTypeEnum];