# List summary

URL: https://docs.hanzo.ai/docs/openapi/ad/get-ad-summary

> Rolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and the summed budget and spend across all of them.

`GET /v1/ad/summary`

> [Ad →](https://docs.hanzo.ai/docs/openapi/ad) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/ad/summary`   |
| **Method**    | `GET`                                  |
| **Operation** | `get_ad_summary`                       |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Rolls the caller org's ad campaigns up into four numbers: how many
campaigns exist, how many are active, and the summed budget and spend across
all of them. Budget and spend are MINOR units (cents), the same units the
campaign rows carry. It counts only this org's campaigns.

## Request

`GET /v1/ad/summary` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | ad.adSummary    | ok      |
| `default` | problem-details | refused |

`200` body — 4 fields.

| Field       | In   | Type            | Always | Description                                                         |
| ----------- | ---- | --------------- | ------ | ------------------------------------------------------------------- |
| `active`    | body | integer (int64) | —      | Active is how many of those campaigns are in the active state.      |
| `budget`    | body | integer (int64) | —      | Budget is the summed budget of every campaign in the org, in cents. |
| `campaigns` | body | integer (int64) | —      | Campaigns is how many campaigns the org has, in every state.        |
| `spend`     | body | integer (int64) | —      | Spend is the summed spend of every campaign in the org, in cents.   |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo ad summary
```

**SDK**

**.ts**

```ts
import { Configuration, AdApi } from 'hanzoai';

const api = new AdApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAdSummary();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AdApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AdApi(client).get_ad_summary()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AdAPI.GetAdSummary(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, ad_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ad_api::get_ad_summary(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AdApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AdApi(client).getAdSummary();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/ad/summary \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `ad`, op `get_ad_summary` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "ad",
         "arguments": {
           "op": "get_ad_summary",
           "input": {}
         }
       }
     }'
```

---

[Ad API](https://docs.hanzo.ai/docs/openapi/ad) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)