Sends ONE synthetic pageview through the connected destination end to end and…
Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said.
POST /v1/destination/{platform}/test
| Address | https://api.hanzo.ai/v1/destination/{platform}/test |
| Method | POST |
| Operation | post_destination_by_platform_test |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sends ONE synthetic pageview through the connected destination end to end and reports what the platform said. A send the platform refuses is reported as data — {"ok": false, "error": …} at 200 — so the console shows the platform's own words rather than an error about Hanzo. It requires org admin.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
platform | path | string | yes | Platform is the destination to act on, from the path: ga4 | meta | tiktok | linkedin | x | reddit | insights | analytics. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | destinationTest | ok |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
error | body | string | — | Error is the platform's rejection, present only on a failed send. |
message | body | string | — | Message is the platform's own note about the send, present only on success. |
ok | body | boolean | — | OK is true when the platform accepted the synthetic event. |
sent | body | integer | — | Sent is how many events the platform accepted, present only on success. |
Failure carries the platform error shape — see Errors.
Examples
hanzo destinations test <platform>import { Configuration, DestinationApi } from 'hanzoai';
const api = new DestinationApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postDestinationByPlatformTest({ platform: 'platform' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DestinationApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DestinationApi(client).post_destination_by_platform_test(platform='platform')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DestinationAPI.PostDestinationByPlatformTest(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, destination_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = destination_api::post_destination_by_platform_test(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DestinationApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new DestinationApi(client).postDestinationByPlatformTest();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 -X POST https://api.hanzo.ai/v1/destination/<platform>/test \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches destination through the destinations tool, which names its 5 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_destinations"
}
}
}'How is this guide?