> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.hive.co/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.hive.co/_mcp/server.

# Get aggregate campaign stats

GET https://api.hive.co/v2/campaigns/email/stats/

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

Reference: https://developers.hive.co/api-reference/hive-api/campaigns/email-aggregate-stats-retrieve

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `campaign_ids` (string, optional) — Comma-separated campaign IDs, max 100.
- `sent_after` (datetime, optional)
- `sent_before` (datetime, optional)

### Headers

- `X-Partner-Id` (string, required) — Your OAuth application client ID.

## Response

### 200

- `campaigns_included` (integer, required)
- `stats_refreshed_at` (datetime, required, nullable)
- `stats` (CampaignStats, required, nullable) — Explicit, versioned view over the cached stats blob — the raw blob is never passed through, so internal key changes can't break API consumers. Sections the campaign has no cached data for serialize as null.

## Errors

### 422 Unprocessable Entity Error

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.

- `map from string to any`

## Types

### CampaignStats

Explicit, versioned view over the cached stats blob — the raw blob is never passed through, so internal key changes can't break API consumers. Sections the campaign has no cached data for serialize as null.

- `revenue` (CampaignRevenue, required, nullable)
- `counts` (CampaignEngagementCounts, optional, nullable)
- `rates` (CampaignEngagementRates, optional, nullable)

### CampaignRevenue

- `ecommerce` (CampaignChannelRevenue, optional, nullable)
- `ticketing` (CampaignChannelRevenue, optional, nullable)
- `total` (CampaignChannelRevenue, optional, nullable)

### CampaignEngagementCounts

- `sent` (integer, optional, default: 0)
- `delivered` (integer, optional, default: 0)
- `opened` (integer, optional, default: 0)
- `clicked` (integer, optional, default: 0)
- `bounced` (integer, optional, default: 0)
- `soft_bounced` (integer, optional, default: 0)
- `spam_complained` (integer, optional, default: 0)
- `unsubscribed` (integer, optional, default: 0)

### CampaignEngagementRates

- `delivery_rate` (double, optional)
- `open_rate` (double, optional)
- `click_rate` (double, optional)
- `bounce_rate` (double, optional)
- `spam_complaint_rate` (double, optional)
- `unsubscribe_rate` (double, optional)
- `estimated_non_prefetched_open_rate` (double, optional)

### CampaignChannelRevenue

- `num_orders` (integer, optional, default: 0)
- `total_revenue` (double, optional, default: 0)

## Examples

**Response**

```json
{
  "campaigns_included": 1,
  "stats_refreshed_at": "2024-01-15T09:30:00Z",
  "stats": {
    "revenue": {
      "ecommerce": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "ticketing": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "total": {
        "num_orders": 0,
        "total_revenue": 0
      }
    },
    "counts": {
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "clicked": 0,
      "bounced": 0,
      "soft_bounced": 0,
      "spam_complained": 0,
      "unsubscribed": 0
    },
    "rates": {
      "delivery_rate": 1.1,
      "open_rate": 1.1,
      "click_rate": 1.1,
      "bounce_rate": 1.1,
      "spam_complaint_rate": 1.1,
      "unsubscribe_rate": 1.1,
      "estimated_non_prefetched_open_rate": 1.1
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.hive.co/v2/campaigns/email/stats/"

headers = {
    "X-Partner-Id": "X-Partner-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.hive.co/v2/campaigns/email/stats/';
const options = {
  method: 'GET',
  headers: {'X-Partner-Id': 'X-Partner-Id', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hive.co/v2/campaigns/email/stats/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Partner-Id", "X-Partner-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.hive.co/v2/campaigns/email/stats/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Partner-Id"] = 'X-Partner-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.hive.co/v2/campaigns/email/stats/")
  .header("X-Partner-Id", "X-Partner-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.hive.co/v2/campaigns/email/stats/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Partner-Id' => 'X-Partner-Id',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.hive.co/v2/campaigns/email/stats/");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Partner-Id", "X-Partner-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Partner-Id": "X-Partner-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hive.co/v2/campaigns/email/stats/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```