REST API

The REST API lets scripts and other systems work with ABlyft: list projects and experiments, create or change experiments, start and pause them, and read results. Requests and responses use JSON.

The base URL is https://app.ablyft.com/api. A complete, interactive reference of all endpoints with their parameters is available at https://app.ablyft.com/docs/api.

AuthenticationCopy Anchor Link

Every request needs an API token in the Authorization header:

Authorization: Bearer YOUR_TOKEN
Accept: application/json

Create a tokenCopy Anchor Link

1. Open your personal settings and go to API Tokens.

2. Click Create token.

3. Enter a Name (shown in your token list) and choose the Permissions:

   Permission	Allows
   Read only	Reading data (GET requests)
   Read & write	Reading, creating, changing and deleting data

4. Copy the token from the dialog. It is shown only once.

The token list shows each token's name, abilities, when it was last used and when it was created. Use Revoke to delete a token. A token does not expire on its own.

A token works for all teams you are a member of, with the permissions of your role in each team, see Roles & permissions. A request with a missing ability returns 403 with the message "Missing required ability: read" (or write).

Rate limitCopy Anchor Link

Requests are limited per user, per minute. By default, a user can make 60 requests per minute. If you exceed the limit, the API answers with HTTP status 429. Wait a moment and retry. Contact ABlyft support if you need a higher limit.

EndpointsCopy Anchor Link

IDs in paths are numeric. {project} is the project ID, {experiment} the experiment ID.

For the standard resources (variations, audiences, pages, goals) use the usual methods: GET to list or show, POST to create, PUT/PATCH to update and DELETE to delete. Creating, updating and deleting needs a Read & write token and the permission of your role.

There is no endpoint that lists all projects at once. First read your teams, then the projects of each team.

Change the status of an experimentCopy Anchor Link

Send one of draft, preview, running, pause or archive as status:

curl -X PATCH https://app.ablyft.com/api/projects/12345678/experiments/23456789/status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"status": "running"}'

The response contains the updated experiment. Make sure the experiment has at least one variation, page and goal before you start it, as in the app, see Before you can preview or start.

Reduce the responseCopy Anchor Link

On experiment requests, add ?fields=id,name,status to get only these fields.

ExamplesCopy Anchor Link

List your teams and projectsCopy Anchor Link

curl https://app.ablyft.com/api/teams \
  -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json"

[
  { "id": 1234, "name": "My company", "created_at": "2025-01-15T09:30:00.000000Z", "updated_at": "2025-06-01T12:00:00.000000Z" }
]

curl https://app.ablyft.com/api/teams/1234/projects \
  -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json"

The response lists each project with fields such as id, name, storage, snippet_revision and snippet_version.

List experimentsCopy Anchor Link

curl "https://app.ablyft.com/api/projects/12345678/experiments?fields=id,name,status" \
  -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json"

[
  { "id": 23456789, "name": "Product page: bigger buy button", "status": "running" }
]

Without fields, each experiment also contains description, example_url, traffic_allocation, audiences_match_type, tags, js, reset_js, css, and the variations.

Read resultsCopy Anchor Link

curl https://app.ablyft.com/api/projects/12345678/experiments/23456789/results \
  -H "Authorization: Bearer YOUR_TOKEN" -H "Accept: application/json"

The response is a list with one entry per goal (abbreviated here). variationStatistics is keyed by variation ID:

[
  {
    "id": 34567890,
    "type": "custom",
    "name": "Newsletter signup",
    "api_name": "newsletter-signup",
    "variationStatistics": {
      "87654321": { "id": 87654321 }
    }
  }
]

The statistics object of each variation contains participants, conversions, values and the significance figures that the results page shows. The fields are listed in the interactive reference. The optional query parameters startDate, endDate and deviceTypes filter the results. If an experiment has no results yet, the API answers with 404 and "No result found for this experiment".

ErrorsCopy Anchor Link

Next stepsCopy Anchor Link