{
  "opencollection": "1.0.0",
  "info": {
    "name": "Samsara Custom API",
    "version": "2024-11-18"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Custom",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "[preview] Get Custom Report Configs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/preview/custom-reports/configs",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The limit for how many reports will be in the response. Default and max for this value is 100 objects."
              }
            ]
          },
          "docs": "Get paginated custom report configs created in the organization.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta 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>\n\nEndpoints in this section are in Preview. Th"
        },
        {
          "info": {
            "name": "[preview] Get Custom Report Runs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/preview/custom-reports/runs",
            "params": [
              {
                "name": "customReportIds",
                "value": "",
                "type": "query",
                "description": "Required array of custom report IDs for the custom report runs wanted. Only one of customReportIds or ids is allowed."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Required array of custom report run IDs to fetch. Only one of ids or customReportIds is allowed."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
              }
            ]
          },
          "docs": "Get all custom report runs with the provided IDs or customReportIds.\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta 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>\n\nEndpoints in this section are in Preview"
        },
        {
          "info": {
            "name": "[preview] Create a Custom Report Run",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.samsara.com/preview/custom-reports/runs",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a custom report run which then gets queued up to generate custom report data for the report run.\n\n <b>Rate limit:</b> 240 requests/day (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Write Custom Reports** under the Closed Beta 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>\n\nEn"
        },
        {
          "info": {
            "name": "[preview] Get Custom Report Run Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.samsara.com/preview/custom-reports/runs/data",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "The ID of the specified run for the requested custom report."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results."
              }
            ]
          },
          "docs": "This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports).\n\n <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\">here</a>).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Bet"
        }
      ]
    }
  ],
  "bundled": true
}