> For the complete documentation index, see [llms.txt](https://docs.intelligems.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.intelligems.io/developer-resources/external-api.md). # External API {% hint style="warning" %} Our API is currently in Beta. Have thoughts on how to make our API better? Email your feature suggestions to . {% endhint %} ### What is the External API? The Intelligems External API provides programmatic access to your Intelligems experiences and analytics data. This RESTful API allows you to integrate Intelligems functionality into your own applications, workflows, and data pipelines. ### What can you do with the External API? The External API enables you to: **Retrieve & Analyze Data** * List all tests and experiences in your account * Get detailed configuration for specific tests and experiences, including variations, targeting rules, offer details, and content modifications * Pull performance metrics for any test or experience, with results broken down by audience segments (device type, visitor type, traffic source, geography, etc.) * Fetch sitewide analytics including revenue per visitor, net revenue, and visitor counts for any date range **Manage Experiences** * Create new experiences and experiments programmatically * Update existing experience configurations, variations, and targeting rules * Control experience lifecycles — start, pause, or end experiences via API **Automate Workflows** * Integrate Intelligems data into your business intelligence tools * Build custom dashboards combining Intelligems metrics with other data sources * Automate reporting and alerting based on test performance ### Common Use Cases * **Custom Reporting**: Build internal dashboards that combine Intelligems test results with proprietary business metrics. * **Automated Monitoring**: Create alerts to notify you if there's an issue with a test or give you a daily summary. * **Automated Reporting**: Create automation engines that give you insights during key stages of a test (7 days live, 14 days live, test ended). {% hint style="info" %} ***Checkout our*** [***Automations & Guides sections***](https://docs.intelligems.io/developer-resources/external-api/automations-and-guides) ***for how-tos of common use cases.*** {% endhint %} ### Getting Started To generate your API key, in your Intelligems account, navigate to *Integrations* > Intelligems *External API* > Select *Enable*. A pop-up will appear with your API key. You can also navigate back here at any time to grab that same API key again.
Once you have your API key, you can authenticate requests by including it in the `intelligems-access-token` header. #### Available Endpoints **Experiences** * **GET /v25-10-beta/experiences-list** — Retrieve a paginated list of experiences with optional filtering by `category` and `status` * **GET /v25-10-beta/experiences/{experienceId}** — Get complete details for a specific experience * **POST /v25-10-beta/experiences** — Create a new experience or experiment * **PUT /v25-10-beta/experiences/{experienceId}** — Update an existing experience's configuration, variations, or targeting * **POST /v25-10-beta/experiences/{experienceId}/actions/{action}** — Perform a lifecycle action on an experience (`start`, `pause`, or `end`) **Experience & Experiment Analytics** * **POST /v25-10-beta/analytics/resource/{experienceId}** — Retrieve analytics for an experience (metrics, variations, optional graphs). Accepts filters and all request settings in the JSON body. **Use this for all new integrations.** * **POST /v25-10-beta/analytics/experience/{experienceId}/timeseries** — Metric-over-time data for a single experience * **POST /v25-10-beta/analytics/experience/{experienceId}/export** — Export an experience's analytics dataset * **GET /v25-10-beta/analytics/resource/{experienceId}** — *Deprecated.* Legacy query-parameter analytics endpoint, kept only as a beta compatibility path and removed when the beta ends. Use the POST variant above instead. **Sitewide Analytics** * **POST /v25-10-beta/analytics/sitewide/snapshot** — Summary KPI metrics with period-over-period percent changes and optional audience segmentation * **POST /v25-10-beta/analytics/sitewide/timeseries** — Metric-over-time data with configurable granularity and optional audience segmentation * **POST /v25-10-beta/analytics/sitewide/order-distribution** — Order-value histogram (KDE/CDF) and unit-mix breakdown * **POST /v25-10-beta/analytics/sitewide/conversion-funnel** — Sitewide conversion funnel as a Sankey graph (traffic source → landing page → cart → checkout → conversion) **Holiday Benchmark** * **POST /v25-10-beta/analytics/event/snapshot** — Benchmark event snapshot metrics * **POST /v25-10-beta/analytics/event/timeseries** — Benchmark event metric-over-time data For detailed endpoint documentation including parameters, request examples, and response schemas, see the [API Reference](https://docs.intelligems.io/developer-resources/external-api/fetch-experience-data). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.intelligems.io/developer-resources/external-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.