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 Custom API

The Custom API from Samsara — 3 operation(s) for custom.

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

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

This API exposes 4 operations across 3 paths, and defines 51 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/.

4 operations 3 paths 51 schemas 3 GET1 POST

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 Custom API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (AccessTokenHeader). By default, every request must be authenticated.

Paths & Operations 4

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

Custom 4
GET
/preview/custom-reports/configs
[preview] Get Custom Report Configs
getCustomReportConfigs 2 params → 200401404405429500501502
GET
/preview/custom-reports/runs
[preview] Get Custom Report Runs
getCustomReportRuns 3 params → 200401404405429500501502
POST
/preview/custom-reports/runs
[preview] Create a Custom Report Run
postCustomReportRun body → 200401404405429500501502
GET
/preview/custom-reports/runs/data
[preview] Get Custom Report Run Data
getCustomReportRunData 2 params → 200401404405429500501502

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are GetCustomReportRunObjectResponseBody (10 properties), CustomReportsPostCustomReportRunRequestBody (5 properties), CustomReportColumnsObjectResponseBody (4 properties), PostCustomReportRunResponseObjectResponseBody (3 properties). Each schema is shown below with its type and property counts.

CustomReportsGetCustomReportConfigsResponseBody
object
2 properties 2 required
CustomReportsPostCustomReportRunUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
CustomReportsGetCustomReportRunsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
CustomReportConfigObjectResponseBody
object
Full Custom report config object
3 properties 3 required
CustomReportsPostCustomReportRunBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
CustomReportColumnsObjectResponseBody
object
Information about a custom report column.
4 properties 2 required
GetCustomReportRunObjectResponseBody
object
The full custom report run object.
10 properties 8 required
CustomReportsGetCustomReportRunsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
CustomReportsGetCustomReportRunDataBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
CustomReportsPostCustomReportRunNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
CustomReportsGetCustomReportRunDataUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties 2 required
CustomReportsPostCustomReportRunServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
CustomReportsPostCustomReportRunBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
CustomReportsPostCustomReportRunNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
CustomReportsGetCustomReportRunsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
CustomReportsGetCustomReportRunDataNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
CustomReportsGetCustomReportRunDataTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsPostCustomReportRunRequestBody
object
This creates and queues a new custom report run for the given body parameters.
5 properties 3 required
CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
CustomReportsGetCustomReportRunDataMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
CustomReportsGetCustomReportRunsNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
CustomReportsGetCustomReportRunsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties 2 required
CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
CustomReportsGetCustomReportRunsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties 2 required
CustomReportsGetCustomReportRunDataInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
CustomReportsPostCustomReportRunGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
CustomReportsGetCustomReportRunsResponseBody
object
2 properties 2 required
CustomReportsPostCustomReportRunInternalServerErrorResponseBody
object
An internal server error occurred
2 properties 2 required
GetCustomReportRunDataObjectResponseBody
object
2 properties 1 required
PostCustomReportRunResponseObjectResponseBody
object
Full post custom report run response object
3 properties 3 required
CustomReportsGetCustomReportRunsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties 2 required
CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsPostCustomReportRunMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties 2 required
CustomReportsGetCustomReportRunDataBadRequestErrorResponseBody
object
Bad Request parameters
2 properties 2 required
CustomReportsGetCustomReportRunDataGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
CustomReportsPostCustomReportRunTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsGetCustomReportRunDataNotFoundErrorResponseBody
object
Resource not found
2 properties 2 required
CustomReportsGetCustomReportRunDataResponseBody
object
2 properties 2 required
CustomReportsGetCustomReportRunDataServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
CustomReportsGetCustomReportRunsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties 2 required
CustomReportsPostCustomReportRunResponseBody
object
1 property 1 required
CustomReportsGetCustomReportRunsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties 2 required
CustomReportsGetCustomReportRunsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required
CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

samsara-custom-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 Custom 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.