Rolls the caller org's ad campaigns up into four numbers: how many campaigns…
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…
GET /v1/ad/summary
| 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 | adSummary | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
active | body | integer | — | Active is how many of those campaigns are in the active state. |
budget | body | integer | — | Budget is the summed budget of every campaign in the org, in cents. |
campaigns | body | integer | — | Campaigns is how many campaigns the org has, in every state. |
spend | body | integer | — | Spend is the summed spend of every campaign in the org, in cents. |
Failure carries the platform error shape — see Errors.
Examples
hanzo ads summaryimport { Configuration, AdApi } from 'hanzoai';
const api = new AdApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAdSummary();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()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AdAPI.GetAdSummary(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AdApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new AdApi(client).getAdSummary();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/ad/summary \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches ad through the ads tool, which names its 7 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_ads_campaigns"
}
}
}'How is this guide?