OpenapiMarketing
Returns one of the caller org's saved audiences.
Returns one of the caller org's saved audiences.
GET /v1/marketing/audiences/{id}
| Address | https://api.hanzo.ai/v1/marketing/audiences/{id} |
| Method | GET |
| Operation | get_marketing_audiences_by_id |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one of the caller org's saved audiences. An audience belonging to another org reads as not found.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the audience id from the path, as returned by create. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Audience | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdAt | body | integer | — | CreatedAt is unix seconds when the filter was saved, server-assigned. |
event | body | string | — | Event is the analytics event a member must have fired. |
id | body | string | — | ID is the server-assigned audience id ("aud_" + 128 random bits). |
name | body | string | — | Name is the audience's label. |
updatedAt | body | integer | — | UpdatedAt is unix seconds of the last write, server-assigned, and the key the audience list is ordered by (newest first). |
windowDays | body | integer | — | WindowDays is how far back the event counts, ending now. |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing audiences get <id>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingAudiencesById({ 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_audiences_by_id(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingAudiencesById(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_audiences_by_id(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MarketingApi(client).getMarketingAudiencesById();curl https://api.hanzo.ai/v1/marketing/audiences/<id> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches marketing through the marketing tool, which names its 35 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_marketing_audiences"
}
}
}'How is this guide?