How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Samsara Preview A P Is API

The Preview A P Is API from Samsara — 4 operation(s) for preview a p is.

Samsara Preview A P Is API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Preview A P Is. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 5 operations across 4 paths, and defines 71 schemas. It is described by OpenAPI 3.0.1, at version 2024-11-18.

Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.

5 operations 4 paths 71 schemas 1 DELETE3 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2024-11-18
Base URL
https://api.samsara.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Samsara Preview A P Is API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessTokenHeader). By default, every request must be authenticated.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Preview A P Is 5
GET
/preview/cameras/media
[preview] List Uploaded Media by Time Range.
listUploadedMedia 8 params → 200401404405429500501502
GET
/preview/custom-reports/runs/data
[preview] Get Custom Report Run Data
getCustomReportRunData 2 params → 200401404405429500501502
GET
/preview/form-templates
[preview] Get a List of Form Templates.
getFormTemplates 2 params → 200401404405429500501502
DELETE
/preview/training-assignments
[preview] Delete Training Assignments.
deleteTrainingAssignments 1 param → 204401404405429500501502
PATCH
/preview/training-assignments
[preview] Update Training Assignments.
patchTrainingAssignments 2 params → 200401404405429500501502

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are TrainingAssignmentResponseObjectResponseBody (16 properties), FormsFieldDefinitionObjectResponseBody (15 properties), FormTemplateResponseObjectResponseBody (11 properties), UploadedMediaObjectResponseBody (8 properties). Each schema is shown below with its type and property counts.

TrainingAssignmentsDeleteTrainingAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
MediaRetrievalListUploadedMediaNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
FormTemplateSectionObjectResponseBody
object
Form Template section object.
3 properties 3 required
TrainingAssignmentsPatchTrainingAssignmentsResponseBody
object
1 property 1 required
FormTemplateResponseObjectResponseBody
object
Form Template response object.
11 properties 10 required
MediaRetrievalListUploadedMediaBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
FormTemplatesGetFormTemplatesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
FormsFieldDefinitionObjectResponseBody
object
Forms field definition object.
15 properties 4 required
FormTemplatesGetFormTemplatesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
CustomReportColumnsObjectResponseBody
object
Information about a custom report column.
4 properties 2 required
CustomReportsGetCustomReportRunDataBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
UrlInfoObjectResponseBody
object
URL info for this piece of media. This field is only populated when the 'status' response field is 'available'
2 properties 2 required
FormsPolymorphicUserObjectResponseBody
object
User or driver object.
2 properties 2 required
FormTemplatesGetFormTemplatesNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
CustomReportsGetCustomReportRunDataUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
MediaRetrievalListUploadedMediaGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
FormsSingleApprovalConfigObjectResponseBody
object
Single approval configuration object.
2 properties 2 required
FormTemplatesGetFormTemplatesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
FormTemplatesGetFormTemplatesResponseBody
object
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
MediaRetrievalListUploadedMediaUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
CustomReportsGetCustomReportRunDataTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsGetCustomReportRunDataNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
TrainingCourseObjectResponseBody
object
Course that is associated with the training assignments.
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
CustomReportsGetCustomReportRunDataMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
SingleApprovalRequirementsObjectResponseBody
object
Single approval requirements object.
1 property 1 required
MediaRetrievalListUploadedMediaServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
FormsSelectOptionObjectResponseBody
object
Multiple choice or checkbox value option object.
4 properties 2 required
CustomReportsGetCustomReportRunDataInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
TrainingLearnerObjectResponseBody
object
Learner that is associated with the training assignment. Only driver learners are supported currently.
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
ListUploadedMediaObjectResponseBody
object
1 property 1 required
FormTemplatesGetFormTemplatesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
MediaRetrievalListUploadedMediaBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
GetCustomReportRunDataObjectResponseBody
object
2 properties 1 required
FormTemplatesGetFormTemplatesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
MediaRetrievalListUploadedMediaNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
CustomReportsGetCustomReportRunDataBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
FormTemplatesGetFormTemplatesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
FormTemplatesGetFormTemplatesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
CustomReportsGetCustomReportRunDataGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
MediaRetrievalListUploadedMediaInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
MediaRetrievalListUploadedMediaResponseBody
object
2 properties 2 required
FormsApprovalConfigObjectResponseBody
object
Form Template approval configuration object.
2 properties 1 required
TrainingAssignmentResponseObjectResponseBody
object
Training Assignment response object.
16 properties 9 required
CustomReportsGetCustomReportRunDataNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
FormTemplatesGetFormTemplatesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
CustomReportsGetCustomReportRunDataResponseBody
object
2 properties 2 required
UploadedMediaObjectResponseBody
object
8 properties 7 required
TrainingAssignmentsPatchTrainingAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
FormTemplatesGetFormTemplatesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsGetCustomReportRunDataServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
MediaRetrievalListUploadedMediaTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
TrainingAssignmentsDeleteTrainingAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
TrainingAssignmentsPatchTrainingAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
MediaRetrievalListUploadedMediaMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

samsara-preview-a-p-is-api-openapi.yml Raw ↑

Other APIs Samsara publishes across the network.

Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
Where this information came from

This is an independent, third-party profile of Samsara Preview A P Is API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.