canonical: https://jentic.com/apis/clickmeter.com/clickmeter # ClickMeter API Jentic publishes the only available OpenAPI specification for ClickMeter API, keeping it validated and agent-ready. ClickMeter is a link tracking and conversion measurement platform for digital marketers, exposing endpoints to create trackable short links, organise them into groups, attach custom domains, and capture downstream conversions. The API covers account configuration, link CRUD with click counters, group and tag management, custom domain registration, and conversion logging. Reports endpoints surface aggregated click and conversion data so agents can attribute traffic across campaigns without scraping a dashboard. ## For AI agents Create and track marketing short links, attach conversions, and pull click counts so agents can attribute campaign traffic and report on link performance. ## Scope Does not handle email or SMS delivery, advertising spend, or website analytics - use for marketing link tracking and conversion logging only. ## Capabilities - Create trackable short links pointing to destination URLs and assign them to campaign groups - Retrieve aggregated click counts for a specific link via /links/{linkId}/count - Register a conversion event tied to a link to measure downstream goals - Organise links into groups and tag them for segmented reporting - Add a custom branded domain so short links resolve under the marketer's own hostname - Update or delete existing links, groups, and conversions when campaigns change ## Use cases ### Campaign Link Attribution Marketing teams generate one trackable ClickMeter link per campaign channel (email, paid social, affiliate) so click volume can be attributed back to source. The API creates the link with POST /links, returns the short URL, and exposes click totals via GET /links/{linkId}/count. Setup for a multi-channel campaign typically takes minutes once the group structure is in place. Example prompt: Create a ClickMeter link pointing to https://example.com/spring-sale inside the 'Spring 2026' group and return the resulting short URL ### Conversion Tracking Across Channels After a click, marketers want to know whether the visitor completed a goal - a signup, a purchase, a download. The ClickMeter API logs conversions via POST /conversions, ties them to the originating link, and lists them through GET /conversions for downstream reporting. This closes the loop between click and outcome without standing up separate analytics infrastructure. Example prompt: Record a conversion of value 49.00 for link ID abc123 and confirm the event appears in the conversions list ### Branded Short Link Domains Brands want short links that reinforce identity rather than a generic shortener domain. The API registers a custom domain via POST /domains; once verified, new links can be issued under that hostname. This typically takes under an hour including DNS propagation, versus several days of custom CNAME and SSL configuration on a self-hosted shortener. Example prompt: Add the custom domain go.brand.example as a branded short-link host and list the existing custom domains on the account ### Agent-Driven Campaign Reporting An AI agent embedded in a marketing tool fetches click and conversion totals for every active campaign, summarises the top performers, and recommends budget shifts. Through Jentic, the agent searches for 'track clicks on a marketing link', loads the relevant ClickMeter operations, and executes them with credentials held in your Jentic One instance. End-to-end integration is under an hour. Example prompt: List every link in the 'Q2 Campaigns' group, fetch click counts for each, and return the three links with the highest click volume ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /links | Create a new trackable link | | GET | /links/{linkId}/count | Get click count for a link | | POST | /conversions | Record a conversion event | | GET | /conversions | List conversion events | | POST | /groups | Create a campaign group | | POST | /domains | Add a custom branded domain | ## Key resources - **Links** — Create, list, update, and delete trackable short links and pull per-link click counts - **Conversions** — Log and retrieve conversion events tied to specific links - **Groups** — Organise links into campaign or category groups for segmented reporting - **Domains** — Register and list custom branded domains used as short-link hosts - **Tags** — Apply tags to links for cross-cutting segmentation - **Reports** — Aggregated click and conversion reporting across links and date ranges - **Account** — Read and update account-level tracking configuration ## Why Jentic - **Setup:** Wiring the ClickMeter API by hand means setting the X-Clickmeter-Authkey header on every call to apiv2.clickmeter.com and stitching together link, conversion, group, and domain operations yourself. Through Jentic you install once, import the ClickMeter API from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** ClickMeter creates links, conversions, groups, and domains from the request body, so scope the agent to the operations it needs, such as creating a tracking link and reading its click count. You choose which operations are in the allowed set, so anything outside it is not callable. - **Credential handling:** Your ClickMeter API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'track clicks on a marketing link' or 'log a conversion event', and Jentic returns the matching ClickMeter operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **ClickSend** — ClickSend handles SMS and email delivery; ClickMeter tracks clicks on the links inside those messages. - **Clicksign** — Clicksign captures e-signature events; ClickMeter measures pre-signature link engagement. - **ClickMeter (v2 API)** — Sister specification for the same vendor exposing the v2 endpoint surface. ## FAQ ### Why is there no official OpenAPI spec for ClickMeter API? ClickMeter does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call ClickMeter API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the ClickMeter API use? The ClickMeter API uses API key authentication. The key is passed in the X-Clickmeter-Authkey header on every request. Through Jentic, the key is stored encrypted in the vault - agents receive scoped access and never see the raw key. ### Can I track conversions tied to a specific link with the ClickMeter API? Yes. POST /conversions records a conversion event against a link, and GET /conversions lists recorded events. You can attach a conversion value so downstream reporting can sum revenue by source link. ### What are the rate limits for the ClickMeter API? Rate limits are not declared in the OpenAPI spec. ClickMeter applies plan-based throttling on its hosted service, so check your plan in the ClickMeter dashboard before issuing high-volume click-count polls. Through Jentic, rate-limit responses surface as standard error objects an agent can retry against. ### How do I create a branded short link with the ClickMeter API through Jentic? Run pip install jentic, then search Jentic for 'create a trackable marketing link' to find POST /links. Load the operation schema, supply the destination URL, group ID, and optional custom domain, and execute. Jentic injects the X-Clickmeter-Authkey header from the vault. ### Can the ClickMeter API attach a custom domain to short links? Yes. POST /domains registers a custom hostname; once DNS is configured the domain appears in GET /domains and can be used as the host for newly created links. ### Can I limit what my agent is allowed to do with the ClickMeter API? Yes. Jentic One is self-hosted, so you decide which ClickMeter operations your agent can call and which credentials it may use. You can allow only the endpoints a task needs, such as creating a tracking link with POST /links and reading its totals via GET /links/{linkId}/count, while withholding operations like POST /conversions, POST /groups, or POST /domains. Anything outside the allowed set is not callable, so the agent cannot register domains or delete links unless you permit it.