# 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 <jerica@intelligems.io>.
{% 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.

<figure><img src="/files/hQkCCPel2VFlL6lsVgFi" alt=""><figcaption></figcaption></figure>

Once you have your API key, you can authenticate requests by including it in the `intelligems-access-token` header.

### Available Endpoints

* **GET /v25-10-beta/experiences-list** — Retrieve a list of all experiences with optional filtering by category, status, and pagination
* **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`)
* **GET /v25-10-beta/analytics/resource/{experienceId}** — Access analytics data for an experience with customizable date ranges and audience segmentation
* **POST /v25-10-beta/analytics/sitewide** — Fetch sitewide analytics (revenue per visitor, net revenue, visitors) for a given date range

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: 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:

```
GET https://docs.intelligems.io/developer-resources/external-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.