Beta APIs

[beta] Gets campaign rollups.

Gets item counts for a campaign grouped by item state, plus the number of items aging in a non-terminal state.

<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>).

To use this endpoint, select Read Campaigns under the Work Orders 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.

get/maintenance/campaigns/rollups

Request

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

Query parameters

campaignIdstring required

Unique ID of the campaign.

Response

OK response.

Example response

{
  "data": {
    "agingItemCount": 7,
    "campaignId": "2d0e5e9b-4b2a-4e4e-9b8e-6c3f8a7d1e2f",
    "itemCountsByState": [
      {
        "count": 42,
        "state": "pending"
      }
    ],
    "totalItemCount": 120
  }
}

Changes

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