canonical: https://jentic.com/apis/clickmeter.com/clickmeter-api # ClickMeter API Jentic publishes the only available OpenAPI specification for ClickMeter API, keeping it validated and agent-ready. This is the full v2 surface of the ClickMeter link tracking platform, exposing 104 endpoints across account management, datapoints (trackable links), groups, conversions, domains, IP blacklists, guest permissions, and aggregated reporting. Endpoints under /aggregated and /clickstream return time-series and event-level data suitable for campaign analysis, while /conversions and /datapoints provide CRUD plus relationship management between conversions and the links that drove them. ## For AI agents Manage the full ClickMeter v2 surface - datapoints, conversions, groups, domains, guests, and aggregated reporting - so agents can build, attribute, and analyse marketing link campaigns end to end. ## Scope Does not handle email or SMS sending, ad spend management, or web session analytics - use for link tracking, conversion logging, and aggregated reporting only. ## Capabilities - Create and manage datapoints (trackable links) with grouping, tagging, and custom destination rules - Log conversion events and link them to one or many datapoints via /conversions/{id}/datapoints/patch - Pull aggregated click and conversion statistics over a timeframe via /aggregated and /aggregated/list - Stream the latest 100 tracking events for an account via GET /clickstream - Manage guest users and per-object permissions for shared link reporting - Maintain IP blacklists and domain whitelists to filter and authorise tracked traffic ## Use cases ### End-to-End Campaign Attribution Marketing operations teams use the v2 surface to provision datapoints per channel, register conversions for downstream goals, then pull /aggregated reports that join clicks to conversions. The endpoint surface lets a team move from raw clickstream data through to summary dashboards without exporting CSVs. Example prompt: Pull aggregated statistics for the timeframe 2026-05-01 to 2026-05-31 grouped by datapoint and return the top five datapoints by conversion count ### Real-Time Clickstream Monitoring GET /clickstream returns the latest 100 tracking events. Operations teams poll this endpoint to spot anomalies - sudden spikes from a single IP, traffic from unexpected geographies, or suspected bot patterns - and react in minutes rather than waiting for nightly reports. Example prompt: Fetch the latest clickstream events and flag any IP address that appears more than 10 times in the most recent 100 hits ### Shared Reporting With Guest Permissions Agencies and freelancers use guest accounts to give clients scoped visibility into their own campaign data. The API creates a guest via POST /account/guests, then grants per-object permissions through /account/guests/{id}/{type}/permissions/patch. Setup takes minutes per client versus rebuilding standalone reporting portals. Example prompt: Create a guest user for client@example.com with read permissions on group ID 4421 and confirm the permission was set ### Agent-Driven Campaign Optimisation An AI agent monitors aggregated conversion rates per datapoint, identifies underperforming links, and rewrites destination URLs or pauses spend. Through Jentic, the agent searches for 'pull aggregated click and conversion stats', loads the operation, and executes against credentials held in your Jentic One instance. The full optimisation loop runs without human triage of the dashboard. Example prompt: Identify any datapoint with a conversion rate below 1 percent over the last 14 days and return the list with current destination URLs ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /aggregated | Retrieve account statistics for a timeframe | | GET | /aggregated/list | Retrieve account statistics grouped by time bucket | | GET | /clickstream | Retrieve the last 100 tracking events | | POST | /conversions | Create a conversion event | | GET | /conversions/{conversionId}/datapoints | List datapoints linked to a conversion | | POST | /account/guests | Create a guest user | | POST | /account/domainwhitelist | Whitelist a redirect domain in DDU mode | ## Key resources - **Datapoints** — Trackable links - create, update, delete, and pull per-link click and conversion stats - **Conversions** — Conversion events with relationship management against one or many datapoints - **Aggregated** — Time-series and grouped statistics for accounts, groups, datapoints, and conversions - **Clickstream** — Recent event stream limited to the last 100 hits - **Groups** — Group datapoints for segmented reporting and permission scoping - **Account Guests** — Manage guest users and granular per-object permissions - **Domains** — Custom branded short-link domains and DDU domain whitelists - **IP Blacklist** — Exclude specified IPs from event tracking ## Why Jentic - **Setup:** Wiring the ClickMeter v2 API by hand means setting the X-Clickmeter-AuthKey header, choosing the http or https apiv2.clickmeter.com host, and mapping calls across aggregated reports, clickstream, and conversions 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 drives most writes from the request body, so scope the agent to the operations it needs, such as pulling aggregated stats and logging a conversion. You choose which operations are in the allowed set, so account-level changes like adding guests or whitelisting domains are not callable unless you add them. - **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 'pull aggregated click stats' or 'log a conversion against a link', 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 - **ClickMeter (1.0.0)** — Slimmer 1.0.0 surface from the same vendor with 20 endpoints covering core link and conversion CRUD. - **ClickSend** — ClickSend dispatches the SMS or email; ClickMeter v2 measures click and conversion outcomes on the links inside. - **Clientary** — Clientary handles invoicing for client work; ClickMeter v2 supplies the campaign metrics agencies report to those same clients. ## 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 v2 API use? The ClickMeter v2 API uses API key authentication. The key is passed in the X-Clickmeter-AuthKey header on every request. Jentic stores the key encrypted in its vault and injects it at execution time, so agents never see the raw value. ### Can I pull aggregated click statistics with the ClickMeter v2 API? Yes. GET /aggregated returns account-wide stats for a timeframe and GET /aggregated/list returns the same data grouped by time bucket. /aggregated/summary/datapoints, /aggregated/summary/groups, and /aggregated/summary/conversions provide segmented breakdowns. ### What are the rate limits for the ClickMeter v2 API? Rate limits are not declared in this OpenAPI spec. ClickMeter applies plan-based throttling on its hosted service - confirm your plan limits before issuing high-volume polls of /clickstream or /aggregated. Through Jentic, throttle responses surface as standard error objects an agent can retry against. ### How do I link a conversion to multiple datapoints through Jentic? Run pip install jentic, then search Jentic for 'log a conversion against multiple links' to find PUT /conversions/{conversionId}/datapoints/batch/patch. Load the operation, supply the conversion ID and the array of datapoint IDs, and execute. Jentic injects the X-Clickmeter-AuthKey header from the vault. ### Can I share campaign reports with a client using guest permissions? Yes. POST /account/guests creates a guest user, then POST /account/guests/{guestId}/{type}/permissions/patch grants per-object access to specific datapoints, groups, or conversions. This lets agencies share scoped reporting without exposing the full account. ### Can I limit what my agent is allowed to do with the ClickMeter API? Yes. Because you self-host Jentic One, your own rules decide which ClickMeter operations and credentials the agent may call, so you can grant only the endpoints a task needs, such as GET /aggregated for reporting or POST /conversions for logging a conversion. Account-level operations like creating guest users with POST /account/guests or whitelisting a redirect domain with POST /account/domainwhitelist stay off the allowed set unless you add them. Since most writes are driven from the request body, restricting the operation set is what keeps the agent inside its intended scope.