---
title: "[beta] Gets campaign rollups."
method: GET
path: "/maintenance/campaigns/rollups"
tags: ["Beta APIs"]
---

# \[beta\] Gets campaign rollups.

`GET /maintenance/campaigns/rollups`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/maintenance/campaigns/rollups`
- Auth: HTTP bearer

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.

## Query parameters

- `campaignId` string, required

## Response `200`

OK response.

- CampaignsGetCampaignRollupsResponseBody
  - `data` CampaignRollupsResponseObjectResponseBody, required: Progress rollups for a campaign's items.
    - `agingItemCount` integer, required: Number of items that have been in a non-terminal state (`pending`, `hold`, `ready`, `workOrderCreated`) for more than 30 days.
    - `campaignId` string, required: Unique ID of the campaign.
    - `itemCountsByState` CampaignItemStateCountResponseObjectResponseBody[], required: Item counts grouped by state. Every state reported by the service is present, including states with a count of 0.
      - `count` integer, required: Number of items in the state.
      - `state` 'pending' | 'hold' | 'ready' | 'workOrderCreated' | 'complete' | 'dismissed' | 'cancelled' | 'unknown', required: State of the counted items. Valid values: `pending`, `hold`, `ready`, `workOrderCreated`, `complete`, `dismissed`, `cancelled`, `unknown`
    - `totalItemCount` integer, required: Total number of items on the campaign.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)