Beta APIs

[beta] Create a custom report run

Triggers a new custom report run based on the provided configuration.

<b>Rate limit:</b> 50 requests/hour (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write 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.

post/reports/runs

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

Example request

{
  "reportConfig": {
    "columns": [
      {
        "fieldName": "Id"
      }
    ],
    "datasetId": "AssetReadings",
    "filters": {
      "primaryTimeRange": {
        "endTime": "2019-06-13T21:08:25Z",
        "startTime": "2019-06-13T19:08:25Z"
      }
    },
    "id": "4f71fd67-54f0-41de-991c-ee1e031134d1"
  }
}

Response

Accepted response.

Example response

{
  "data": {
    "createdAtTime": "2019-06-13T19:08:25Z",
    "id": "4f71fd67-54f0-41de-991c-ee1e031134d1",
    "status": "complete",
    "updatedAtTime": "2019-06-13T19:08:25Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.