List summary

Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.

GET /v1/marketing/summary

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/summary`
Method	`GET`
Operation	`get_marketing_summary`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Rolls up the caller org's campaigns: how many there are, how many are active, and the summed budget and spend in cents.

Request

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

Response

Status	Body	Meaning
`200`	marketing.Summary	ok
`default`	problem-details	refused

200 body — 4 fields.

Field	In	Type	Always	Description
`active`	body	integer (int64)	—	Active is how many of them sit in the "active" state exactly.
`budget`	body	integer (int64)	—	Budget is every campaign's budget summed, in USD cents.
`campaigns`	body	integer (int64)	—	Campaigns is how many campaigns the org has, counted in every lifecycle state including draft and completed.
`spend`	body	integer (int64)	—	Spend is every campaign's spend summed, in USD cents.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing summary

.ts

.py

.go

.rs

.java

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingSummary();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_summary()

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

resp, _, err := client.MarketingAPI.GetMarketingSummary(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, marketing_api};

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

let result = marketing_api::get_marketing_summary(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;

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

var result = new MarketingApi(client).getMarketingSummary();

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

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

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": "marketing",
         "arguments": {
           "op": "get_marketing_summary",
           "input": {}
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList sequences NextList suppressions