---
title: "Get aggregate SMS campaign stats"
method: GET
path: "/campaigns/sms/stats/"
tags: ["campaigns"]
---

# Get aggregate SMS campaign stats

`GET /campaigns/sms/stats/`

## Request

- Base URL: `https://api.hive.co/v2`
- URL: `https://api.hive.co/v2/campaigns/sms/stats/`
- Auth: HTTP bearer

One set of stats totalled across SMS campaigns. Counts and revenue are summed; rates are recalculated from the summed counts. `sent_after` is inclusive and `sent_before` exclusive.

## Query parameters

- `campaign_ids` string
- `sent_after` string, date-time
- `sent_before` string, date-time

## Headers

- `X-Partner-Id` string, required

## Response `200`

- AggregateSMSCampaignStatsResponse
  - `campaigns_included` integer, required
  - `stats_refreshed_at` string, date-time, nullable, required
  - `stats` SMSCampaignStats, required: Explicit, versioned view over the stats dict assembled by SMSCampaignsService. The cached subdocuments are never passed through, so internal key changes can't break API consumers.
    - `counts` SMSCampaignEngagementCounts
      - `sent` integer
      - `delivered` integer
      - `clicked` integer
      - `failed` integer
      - `opted_out` integer
      - `opted_in` integer
      - `undeliverable` integer
    - `rates` SMSCampaignEngagementRates
      - `delivery_rate` number, double
      - `click_rate` number, double
      - `opt_out_rate` number, double
      - `failed_rate` number, double
    - `revenue` SMSCampaignRevenue
      - `ecommerce` CampaignChannelRevenue
        - `num_orders` integer
        - `total_revenue` number, double
      - `ticketing` CampaignChannelRevenue
        - `num_orders` integer
        - `total_revenue` number, double
      - `total` CampaignChannelRevenue
        - `num_orders` integer
        - `total_revenue` number, double

## Other responses

- `422`: The request was rejected on its query parameters. Field errors are keyed by parameter name, rejections on the parameter values (e.g. an unknown ID) use a flat `errors` list.

---

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