PIMMS API
★ Only Publicly Available OpenAPI DocumentMarketingMarketing Automationbearer3 EndpointsREST
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.
Install Jentic One Beta
Connect the PIMMS API to your agent
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.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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.
Capabilities
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
Use Cases
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
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for pimms api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/links
Create a new tracked link
PUT
/links/upsert
Create or update a link configuration
GET
/analytics
Retrieve click analytics data
POST
/links
Create a new tracked link
PUT
/links/upsert
Create or update a link configuration
GET
/analytics
Retrieve click analytics data
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
PIMMS Bearer tokens are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens so raw API keys never enter the agent context.
Intent-based discovery
Agents search by intent (e.g., 'create a tracked marketing link') and Jentic returns matching PIMMS operations with their input schemas, so the agent can call the right endpoint without reading docs.
Time to first call
Direct PIMMS integration: under 1 day for auth and link creation setup. Through Jentic: under 30 minutes — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
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 at https://app.jentic.com/sign-up.
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 the MAXsystem vault 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.
GET STARTED