Algolia A/B Testing API
Base URLs Base URLs for the A/B testing API: https://analytics.us.algolia.com https://analytics.de.algolia.com https://analytics.algolia.com (alias of…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Base URLs
Base URLs for the A/B testing API:
https://analytics.us.algolia.comhttps://analytics.de.algolia.comhttps://analytics.algolia.com(alias ofanalytics.us.algolia.com)
Use the URL that matches your analytics region.
All requests must use HTTPS.
Availability and authentication
Access to the A/B testing API is available as part of the Premium or Elevate plans.
Add these headers to authenticate requests:
x-algolia-application-id. Your Algolia application ID.x-algolia-api-key. An API key with the necessary permissions to make the request.
The required access control list (ACL) to make a request is listed in each endpoint's reference.
You can find your application ID and API key in the Algolia dashboard.
Rate limits
You can make up to 100 requests per minute per app to the A/B testing API.
The response includes headers with information about the limits.
Parameters
Query parameters must be URL-encoded.
Non-ASCII characters must be UTF-8 encoded.
Plus characters (+) are interpreted as spaces.
Response status and errors
The A/B testing API returns JSON responses.
Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.
Successful responses return 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses.
Error responses have a message property with more information.
Version
Version 2 of the A/B Testing API, indicated by the /2/ in each endpoint's URL, is deprecated.
Use version 3 instead.
Endpoints 11
abtesting
- GETSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - PUTSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - POSTSend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - DELETESend requests to the Algolia REST API
/:pathThis method lets you send requests to the Algolia REST API. - GETList all A/B tests
/2/abtestsDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by GET /3/abtests. Lists all A/B tests you configured for this… - POSTCreate an A/B test
/2/abtestsDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by POST /3/abtests. Creates a new A/B test. - GETRetrieve A/B test details
/2/abtests/:idDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by GET /3/abtests/{id}. Retrieves the details for an A/B test by its ID. - DELETEDelete an A/B test
/2/abtests/:idDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by DELETE /3/abtests/{id}. Deletes an A/B test by its ID. - POSTStop an A/B test
/2/abtests/:id/stopDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by POST /3/abtests/{id}/stop. Stops an A/B test by its ID. You can't… - POSTEstimate the sample size and duration of an A/B test
/2/abtests/estimateDeprecated. This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by POST /3/abtests/estimate. Given the traffic percentage and the… - GETSwitch the API key used to authenticate requests
/setClientApiKey?apiKey=stringSwitch the API key used to authenticate requests.
API details
- Base URL
https://analytics.{region}.algolia.comhttps://analytics.algolia.com- Authentication
- An API key in the x-algolia-application-id header
An API key in the x-algolia-api-key header - Operations
- 11 operations on 6 pathsGET 4POST 4DELETE 2PUT 1
6 marked deprecated - Main resources
- abtesting 11
- Response formats
application/json- Description format
- OpenAPI 3.0.2, API version
2.0.0 - Links
- Documentation · OpenAPI document
How to test the Algolia A/B Testing API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Algolia A/B Testing API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-algolia-application-id header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Send requests to the Algolia REST API” (GET /:path), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Algolia A/B Testing API?
Base URLs Base URLs for the A/B testing API: https://analytics.us.algolia.com https://analytics.de.algolia.com https://analytics.algolia.com (alias of… It is listed under Developer tools and has 11 endpoints.
Who publishes the Algolia A/B Testing API?
It is listed from Algolia's public API description (an OpenAPI document), not published by Algolia on Swastik Codes. Anyone who controls algolia.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Algolia A/B Testing API?
Its description lists 2 base URLs: https://analytics.{region}.algolia.com, https://analytics.algolia.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Algolia A/B Testing API?
It accepts 2 methods: an API key in the x-algolia-application-id header; an API key in the x-algolia-api-key header.
How many endpoints does the Algolia A/B Testing API have?
11 operations on 6 paths (4 GET, 4 POST, 2 DELETE, 1 PUT). The largest groups are abtesting.
Is forking the Algolia A/B Testing API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.