Reporting API
Monitor OptiMonk's performance in your go-to reporting tool by sending data via our reporting API.
The OptiMonk Reporting API is a public REST API that gives you programmatic access to your OptiMonk campaign performance data, allowing you to pull metrics such as impressions, conversions, conversion rate, subscriber counts, and visitor limits into any reporting tool, business intelligence dashboard, or custom analytics setup you already use. The API base URL is https://api.optimonk.com/v1 and authenticates via an API key generated directly in your OptiMonk account settings. Available endpoints cover overall and per-campaign statistics, lead exports with time-range and pagination support, account-level information, and aggregated reports groupable by day, week, month, or year. This makes it possible to build a unified performance dashboard that places OptiMonk campaign data alongside metrics from your other marketing channels — without requiring a manual export or a third-party connector.
Key benefits
- Bring OptiMonk data into any reporting environment: Because the API returns standard JSON responses, OptiMonk campaign metrics can be ingested by any BI tool, data warehouse, or custom dashboard that can make HTTP requests — including Tableau, Looker, Google Data Studio, Power BI, or a purpose-built internal dashboard. No dedicated OptiMonk connector is required.
- Five key metrics, filterable by time range and campaign: The reporting endpoints expose conversions, impressions, conversion rate, subscriber count, and visitor limit — the core metrics needed to evaluate popup campaign performance. Each can be queried for all campaigns at once or for a single specific campaign, and reports can be scoped to any custom date range or grouped by daily, weekly, monthly, or yearly intervals.
- Lead export with full pagination and time filtering: The leads endpoint lets you export the raw subscriber list for all campaigns or filter by date range, paginating through large result sets. This enables automated lead pipeline ingestion into a CRM or data warehouse without requiring manual CSV downloads from the OptiMonk dashboard.
How it works
Log in to your OptiMonk account, click on your account menu at the bottom of the left navigation bar, and select Settings. Under the Account section, click Generate API key. Copy the key — it is shown immediately and is ready to use. Share it with the developer who will build or configure the integration.
All requests to https://api.optimonk.com/v1 require the API key in the x-api-key request header. Choose the appropriate endpoint for your use case: /v1/report/ for aggregated campaign metrics, /v1/report/{campaignId} for a single campaign, /v1/leads/ for subscriber export, or /v1/campaigns/ for campaign metadata. Add query parameters such as from, to, and groupBy to scope the data.
The API returns standard JSON. A developer connects the endpoint to your BI tool, dashboard, or data pipeline — writing the query logic once, then scheduling it to refresh automatically. The full API documentation, including response examples and test utilities, is available at https://api.optimonk.com/documentation/static/index.html.
Frequently asked questions
What is the OptiMonk Reporting API?+
The OptiMonk Reporting API is a public REST API that provides programmatic access to your OptiMonk campaign performance data. Available endpoints cover campaign statistics, lead exports, account information, and aggregated reports with time-range filtering. It is designed to allow teams to pull OptiMonk metrics into custom dashboards, BI tools, or data warehouses without manual exports. The base URL is https://api.optimonk.com/v1 and authentication is handled via an API key.
What metrics can I access through the Reporting API?+
The reporting endpoints expose five key metrics: conversions (the number of successful campaign conversions), impressions (how many times campaigns were shown), conversion rate (conversions divided by impressions), subscribers (the number of leads captured), and visitor limit (your account's visitor cap usage). These can be queried at the overall account level or broken down per campaign, and can be grouped by daily, weekly, monthly, or yearly intervals.
Do I need a developer to use the Reporting API?+
To build a custom integration or dashboard, developer assistance is typically required. The API uses standard REST conventions and returns JSON, so any developer familiar with HTTP APIs can implement it using the code examples in the documentation (available in PHP and JavaScript, among others). Generating the API key itself requires no technical knowledge and is done directly in the OptiMonk account settings.
Can I export leads through the API?+
Yes. The /v1/leads/ endpoint exports subscriber data for all campaigns. You can filter by time range using the from and to parameters, or use predefined intervals (daily, weekly, monthly, yearly). The endpoint supports pagination via the page parameter, making it suitable for exporting large subscriber lists in batches. This allows automated lead ingestion into a CRM or data warehouse on a scheduled basis.
Is there a rate limit on the Reporting API?+
Yes. The API enforces a rate limit per API key. If you exceed the allowed number of requests in a given period, the API returns a 429 Too Many Requests response. For setup of high-frequency data pipelines, it is recommended to implement retry logic with exponential backoff in your integration. Specific rate limit thresholds are detailed in the full API documentation at https://api.optimonk.com/documentation/static/index.html.
Try OptiMonk for free
Launch your first campaign, learn what works, then scale what converts.