Install Jentic One Beta
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PIMMS API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpimms.io%2Fpimms" | shStep 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpimms.io%2Fpimms" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
What an agent can do with PIMMS API.
Create tracked links with campaign attribution parameters
Upsert link configurations to update tracking settings without creating duplicates
Retrieve click analytics and conversion attribution data
Track link engagement across marketing channels and campaigns
Measure content performance with per-link analytics
GET STARTED
Patterns agents use PIMMS API for, with concrete tasks.
★ Campaign Link Attribution
Create tracked links for marketing campaigns with attribution parameters that identify the source, medium, and campaign. PIMMS generates unique tracked URLs that record every click, enabling marketers to attribute conversions and measure which channels drive engagement.
Create a tracked link for URL https://example.com/offer with campaign name 'summer-sale' and source 'email'
Click Analytics and Performance Reporting
Query click analytics data for tracked links to measure campaign performance. The /analytics endpoint returns engagement metrics including click counts, referrer data, and temporal patterns, enabling data-driven decisions about which marketing content performs best.
Retrieve click analytics for all links in the 'summer-sale' campaign for the last 30 days
Link Management and Configuration
Manage tracked link configurations through the PIMMS upsert endpoint, which creates new links or updates existing ones based on destination URL. This prevents duplicate tracked links while allowing teams to modify attribution parameters, redirect destinations, or tracking settings as campaigns evolve.
Upsert a link configuration for https://example.com/product with updated campaign parameters and verify the link is active
AI Agent Marketing Attribution
AI agents use the PIMMS API through Jentic to create tracked links and query attribution data without manual configuration. Agents search for link tracking operations by intent, load the endpoint schema, and execute calls with Jentic handling Bearer token authentication.
Search Jentic for 'create tracked marketing link', load the PIMMS /links endpoint schema, and create a tracked link with campaign attribution
3 endpoints — jentic publishes the only available openapi specification for pimms api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
/links
Create a new tracked link
/links/upsert
Create or update a link configuration
/analytics
Retrieve click analytics data
/links
Create a new tracked link
/links/upsert
Create or update a link configuration
/analytics
Retrieve click analytics data
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the PIMMS API by hand means setting up its bearer auth and coding each link creation, upsert, and analytics call yourself. Through Jentic you install once, import PIMMS from the API Directory, store the bearer token once, and your agent calls it.
Permission scoping
PIMMS takes link details in the request body rather than a resource id in the path, so scoping is by operation: you limit the agent to the operations it needs, such as creating a tracked link or reading analytics, and leave the rest out. You choose that set, so an upsert that overwrites links is not included unless you add it.
Credential isolation
Your PIMMS bearer token 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.
Intent-based discovery
Agents search Jentic by intent such as 'create a tracked marketing link' or 'read click analytics', and Jentic returns the matching PIMMS operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Alternatives and complements available in the Jentic catalogue.
Specific to using PIMMS API through Jentic.
Why is there no official OpenAPI spec for PIMMS API?
PIMMS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call PIMMS 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 PIMMS API use?
The PIMMS API uses Bearer token authentication. Your API token is passed in the Authorization header. Through Jentic, this token is stored encrypted in your Jentic One instance and injected automatically into requests.
Can I create tracked links with campaign attribution parameters?
Yes. The POST /links endpoint accepts a destination URL along with campaign, source, and medium parameters. The generated tracked link records all clicks with full attribution data for later analysis.
What analytics data does the PIMMS API return?
The GET /analytics endpoint returns click counts, referrer information, and temporal engagement patterns for your tracked links. You can filter by campaign, date range, and link to measure performance across marketing channels.
How do I create a tracked link through the PIMMS API using Jentic?
Search Jentic for 'create tracked marketing link', load the /links operation schema, and execute with your destination URL and campaign parameters. Jentic handles Bearer token injection and returns the generated tracked link URL.
What is the difference between the /links and /links/upsert endpoints?
POST /links always creates a new tracked link. PUT /links/upsert creates a link if it does not exist or updates the configuration if one already exists for that destination URL. Use upsert to avoid duplicate tracked links for the same content.
Can I limit what my agent is allowed to do with the PIMMS API?
Yes. Because you run Jentic One yourself, your own rules decide which PIMMS operations and credentials the agent may use. PIMMS scopes by operation rather than by resource id, so you grant only the calls the agent needs, such as POST /links to create a tracked link or GET /analytics to read click data. If you do not want the agent overwriting existing links, you simply leave the PUT /links/upsert operation out of the set it can call.
Know of an official OpenAPI document? Contribute it →
For Agents
Create tracked links, manage link configurations, and retrieve click analytics for marketing attribution and campaign performance measurement.
Use for: I need to create a tracked link for a marketing campaign, I want to retrieve click analytics for my links, Get the conversion attribution data for a campaign, List all tracked links with their performance metrics
Not supported: Does not handle email delivery, ad campaign management, or CRM operations - use for link tracking and click attribution only.
Jentic publishes the only available OpenAPI specification for PIMMS API, keeping it validated and agent-ready. PIMMS API provides link tracking and attribution capabilities with 3 endpoints for creating tracked links, upserting link configurations, and retrieving click analytics. The API enables marketing teams to attribute conversions to specific campaigns, channels, and content by generating tracked URLs and querying engagement data.
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
Base layer of spec validity and structural soundness.
Aggregated quality score from linter diagnostics, weighted by severity.
Percentage of `$ref` references that resolve successfully.
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
Structural correctness score based on schema issues using logarithmic dampening.
Clarity, completeness, and ingestion readiness for developers and tooling.
How richly the API is illustrated with examples.
Percentage of examples that conform to their schemas.
Percentage of operations with complete response definitions (success, client error, server error).
Health of API ingestion, bundling, and resolution within Jentic pipelines.
Semantic breadth, depth, and agent comprehension for AI systems.
Coverage of descriptions across API elements.
Coverage of RFC 9457 Problem Details for error responses.
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
Coverage of summaries across operations/tags/info.
Functional utility, complexity comfort, and AI orchestration readiness.
Agent comfort level based on API operational and structural complexity.
Trust, risk posture, and security compliance.
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
Findability, semantic richness, and reasoning readiness.
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>