List stats — GET /v1/marketing/lists/{id}/stats
Returns one list's numbers for charting: subscribers by status, source and consent basis, and over a range of days, what happened each day, the net growth, the confirmation rate and the unsubscribe rate.
GET /v1/marketing/lists/{id}/stats
| Address | https://api.hanzo.ai/v1/marketing/lists/{id}/stats |
| Method | GET |
| Operation | get_marketing_lists_by_id_stats |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one list's numbers for charting: subscribers by status, source and consent basis, and over a range of days, what happened each day, the net growth, the confirmation rate and the unsubscribe rate. Every number is read from kept counts, never by reading the list.
Request
3 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the list, by id or slug, from the path. |
from | query | string | — | From is the first day, YYYY-MM-DD (UTC); 30 days before To by default. |
to | query | string | — | To is the last day, YYYY-MM-DD (UTC); today by default. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | marketing.ListStats | ok |
default | problem-details | refused |
200 body — 20 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
bases | body | object | — | Bases are the subscribers by the consent basis recorded for them, now. |
bases.* | body | integer (int64) | — | |
confirmationRate | body | number (double) | — | ConfirmationRate is the share of the range's requests confirmed in it, between 0 and 1; 0 with none requested. |
counts | body | object | — | Counts are the subscribers by status, now. |
counts.* | body | integer (int64) | — | |
days | body | marketing.Day[] | — | Days are the range, one entry a day, every day present. |
days[].bounced | body | integer (int64) | — | Bounced counts addresses the provider bounced. |
days[].cleaned | body | integer (int64) | — | Cleaned counts addresses removed as unmailable. |
days[].complained | body | integer (int64) | — | Complained counts addresses that reported a mail as spam. |
days[].confirmed | body | integer (int64) | — | Confirmed counts subscriptions confirmed by their address's owner. |
days[].day | body | string | — | Day is the date, YYYY-MM-DD (UTC). |
days[].imported | body | integer (int64) | — | Imported counts rows imports added. |
days[].requested | body | integer (int64) | — | Requested counts subscriptions asked for and waiting to be confirmed. |
days[].subscribed | body | integer (int64) | — | Subscribed counts subscriptions that began without a confirmation (single opt-in, the API, the preference page). |
days[].unsubscribed | body | integer (int64) | — | Unsubscribed counts subscribers who left. |
growth | body | integer (int64) | — | Growth is the range's net change: subscribed, confirmed and imported, less unsubscribed, bounced, complained and cleaned. |
list | body | string | — | List is the list's id. |
sources | body | object | — | Sources are the subscribers by where they came from, now. |
sources.* | body | integer (int64) | — | |
unsubscribeRate | body | number (double) | — | UnsubscribeRate is the range's unsubscribes over the subscribers there were to lose (subscribed now plus those who left in the range), between 0 and 1. |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing lists stats <id>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingListsByIdStats({ id: 'id' });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_lists_by_id_stats(id='id')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingListsByIdStats(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_lists_by_id_stats(&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).getMarketingListsByIdStats();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/marketing/lists/<id>/stats \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches marketing through the marketing tool, which names its 82 operations with its own verbs — this one among them, under a name only MCP 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_marketing_audiences"
}
}
}'