Aimtell API
Browse all Aimtell APIs★ Only Publicly Available OpenAPI DocumentMarketingMarketing AutomationapiKey46 EndpointsREST
For Agents
Send web push notifications, build subscriber segments, and pull campaign analytics for Aimtell-managed websites.
Use for: Send a browser push notification to a subscriber segment, I want to create a manual push campaign for my website, List all subscribers on a specific Aimtell website, Get analytics for a specific site over a date range
Not supported: Does not handle email, SMS, or mobile app push notifications — use for browser-based web push messaging only.
Jentic publishes the only available OpenAPI specification for Aimtell API, keeping it validated and agent-ready. Aimtell is a browser push notification platform for re-engaging website visitors with targeted messages across desktop and mobile web. The API exposes 46 endpoints covering manual, RSS, event-triggered, and welcome campaigns, subscriber and segment management, multi-site analytics, tracking pixels, and notification logs. Authentication uses an X-Authorization API key header, and operations are scoped per website.
Install Jentic One Beta
Connect the Aimtell API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Aimtell 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 Aimtell API.
Send one-off browser push notifications to filtered subscriber segments via the /push endpoint
Create manual, RSS, and event-triggered push campaigns scoped to specific websites
Build and update subscriber segments using attribute and behaviour rules
Track custom subscriber attributes to drive targeted re-engagement flows
Pull analytics aggregated across all sites or filtered to a single website
Inspect notification, event, alias, attribute, and pageview logs for campaign debugging
Use Cases
Patterns agents use Aimtell API for, with concrete tasks.
★ Cart Abandonment Recovery
Re-engage shoppers who abandon their cart by triggering a browser push notification within minutes of exit. The Aimtell API lets you create event-triggered campaigns via /campaigns/event and segment subscribers by recent behaviour, so the right offer reaches the right user without batch scheduling. Setup takes under an hour once the website tracking pixel is installed.
Create an event-triggered campaign on website W12345 that sends a push notification 30 minutes after the cart_abandoned event with title 'Still thinking it over?' and a link back to checkout
Multi-Site Campaign Analytics
Pull push notification performance across every site in a publisher portfolio with a single GET /analytics call, or drill into one site with /analytics/{siteId}. Combined with /campaigns/manual/{campaignId}/clicks, this gives marketing teams a full view of subscriber growth, send volume, and click-through rates without exporting CSVs.
Fetch analytics for all sites between 2026-05-01 and 2026-05-31, then list the three campaigns with the highest click counts
Subscriber Segmentation by Custom Attributes
Track custom attributes on individual subscribers via POST /subscribers/{subscriberId}/attributes and use them as filters when defining a segment with POST /segments. This lets product teams target subscribers by plan tier, lifecycle stage, or feature usage without touching front-end code.
Track attribute plan=premium on subscriber sub_abc123, then create a segment named 'Premium subscribers' filtering on plan equals premium
AI Agent Campaign Operator
An AI agent that monitors product analytics can create and send Aimtell campaigns on demand. Through Jentic the agent searches for the right operation, loads the request schema for /campaigns/manual or /push, and executes the call with the X-Authorization key isolated in the Jentic vault. New campaigns can be drafted, queued, and sent inside one agent run.
Search Jentic for 'send a web push notification', load the /push schema, and send a notification to segment seg_999 with title 'Flash sale' and url https://shop.example.com/sale
Key Endpoints
46 endpoints — jentic publishes the only available openapi specification for aimtell api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/push
Send a one-off push notification
POST
/campaigns/manual
Create a manual push campaign
POST
/campaigns/event
Create an event-triggered campaign
GET
/segments
List subscriber segments
POST
/segments
Create a subscriber segment
GET
/subscribers
List subscribers
GET
/analytics/{siteId}
Get analytics for a specific site
POST
/push
Send a one-off push notification
POST
/campaigns/manual
Create a manual push campaign
POST
/campaigns/event
Create an event-triggered campaign
GET
/segments
List subscriber segments
POST
/segments
Create a subscriber segment
GET
/subscribers
List subscribers
GET
/analytics/{siteId}
Get analytics for a specific site
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
The Aimtell X-Authorization key is stored encrypted in the Jentic vault. Agents call Aimtell through Jentic with scoped tokens — the raw key is never passed to the model context.
Intent-based discovery
Agents search Jentic by intent (e.g. 'send a browser push notification') and Jentic returns the matching Aimtell operation with its input schema, so the agent calls the right endpoint without scraping documentation.
Time to first call
Direct Aimtell integration: 1-2 days for auth, payload shape, and segment lookups. Through Jentic: under 30 minutes — search, load, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Aimtell API through Jentic.
Why is there no official OpenAPI spec for Aimtell API?
Aimtell does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Aimtell 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 Aimtell API use?
The Aimtell API uses an API key passed in the X-Authorization header. When called through Jentic, the key is stored encrypted in the Jentic vault and never enters the agent's context — agents receive scoped access without seeing the raw key.
Can I send a push notification to a specific segment with the Aimtell API?
Yes. POST /push accepts a target segment identifier alongside the notification title, message, and link, and dispatches the notification to all matching subscribers across the chosen website.
What are the rate limits for the Aimtell API?
Aimtell does not publish formal rate limits in the spec. In practice, calls are throttled per account; for high-volume sends use campaign endpoints rather than looping POST /push calls.
How do I create an event-triggered campaign with the Aimtell API through Jentic?
Run pip install jentic, search Jentic for 'create event-triggered push campaign', load the schema for POST /campaigns/event, then execute with the website ID, event name, and notification payload. Jentic injects the X-Authorization header automatically.
Can I track custom subscriber attributes with the Aimtell API?
Yes. POST /subscribers/{subscriberId}/attributes accepts arbitrary string key-value pairs and the values are usable as segment filters, so attributes set in one call become targetable in the next campaign.
GET STARTED