> For the complete documentation index, see [llms.txt](https://docs.elevateab.com/elevate-helpcenter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elevateab.com/elevate-helpcenter/developer-reference/external-api/api-reference.md).

# API reference

Every Elevate A/B Testing External API endpoint and what it is for, plus the OpenAPI 3.1 document for Postman, typed clients, and AI tools.

One page per endpoint: what it returns, its parameters, an example, and what to watch out for.

| Page                                                                                                      | Endpoint                                | Use it for                                          |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------- | --------------------------------------------------- |
| [Current store](/elevate-helpcenter/developer-reference/external-api/api-reference/me.md)                 | `/me`                                   | Checking a key and reading the store's currency     |
| [Store overview](/elevate-helpcenter/developer-reference/external-api/api-reference/store-overview.md)    | `/store/overview`                       | Store-wide traffic and conversion, period on period |
| [List custom events](/elevate-helpcenter/developer-reference/external-api/api-reference/custom-events.md) | `/custom-events`                        | Tracking IDs for custom event goals and filters     |
| [List experiments](/elevate-helpcenter/developer-reference/external-api/api-reference/experiments.md)     | `/experiments`                          | Finding experiments and their IDs                   |
| [Experiment details](/elevate-helpcenter/developer-reference/external-api/api-reference/experiment.md)    | `/experiments/{testId}`                 | How one experiment is set up and what changed       |
| [Experiment summary](/elevate-helpcenter/developer-reference/external-api/api-reference/summary.md)       | `/experiments/{testId}/summary`         | Headline metrics and the status                     |
| [Experiment results](/elevate-helpcenter/developer-reference/external-api/api-reference/results.md)       | `/experiments/{testId}/results`         | Every metric, lift, winner and probabilities        |
| [Experiment timeseries](/elevate-helpcenter/developer-reference/external-api/api-reference/timeseries.md) | `/experiments/{testId}/timeseries`      | How the numbers moved over time                     |
| [Experiment segments](/elevate-helpcenter/developer-reference/external-api/api-reference/segments.md)     | `/experiments/{testId}/segments/{view}` | Which visitors the change worked for                |
| [Filter values](/elevate-helpcenter/developer-reference/external-api/api-reference/filter-values.md)      | `/experiments/{testId}/filter-values`   | What values a filter field holds                    |

Every results endpoint takes the same [filters](/elevate-helpcenter/developer-reference/external-api/filters.md) and [date window](/elevate-helpcenter/developer-reference/external-api/dates-and-time-zones.md), and each request spends [rate limit points](/elevate-helpcenter/developer-reference/external-api/rate-limits.md).

Every field is listed on its page, with its type. The same contract is published as an OpenAPI 3.1 document, generated from the code:

```plaintext
https://elevateab.app/external-api/openapi-v1.json
```

Each version of the API has its own document, named after it (`openapi-v1.json`).

## Use it in your own tools

* **Postman, Insomnia or Bruno:** import the URL above to get every endpoint as a ready-made request.
* **Client generation:** point `openapi-generator`, `oapi-codegen` or your language's equivalent at it for a typed client.
* **AI tools:** give the URL to an assistant so it can call the API with the right parameters.