Counts a click on a share link.
Counts a click on a share link. PUBLIC — it takes no principal, because a visitor clicking a shareable link has no session yet.
POST /v1/affiliate/click
| Address | https://api.hanzo.ai/v1/affiliate/click |
| Method | POST |
| Operation | post_affiliate_click |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Counts a click on a share link. PUBLIC — it takes no principal, because a visitor clicking a shareable link has no session yet.
The ping folds into an in-memory buffer and NEVER writes the money database synchronously, so a click flood cannot contend with the accrual and payout write path; tallies are flushed in one batch on the next authenticated links read and at shutdown. Clicks are a vanity metric: no accrual and no payout ever reads them — those key on real metered spend — so click inflation cannot move money.
Any well-formed code is accepted WITHOUT checking that it exists,
deliberately: this is not a code-existence oracle. counted reports that the
buffer took the ping, not that the code is real; an unknown code simply no-ops
at flush time.
Request
1 field, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
code | body | string | — | Code is the share-link code that was clicked. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | clickCount | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
counted | body | boolean | — | Counted says the in-memory buffer took the ping. |
Failure carries the platform error shape — see Errors.
Examples
hanzo affiliates clickimport { Configuration, AffiliateApi } from 'hanzoai';
const api = new AffiliateApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAffiliateClick({ code: "<code>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AffiliateApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AffiliateApi(client).post_affiliate_click(code="<code>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AffiliateAPI.PostAffiliateClick(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, affiliate_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = affiliate_api::post_affiliate_click(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AffiliateApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new AffiliateApi(client).postAffiliateClick();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/affiliate/click \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "<code>"
}'The door reaches affiliate through the affiliates tool, which names its 17 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_admin_affiliates"
}
}
}'How is this guide?