Algolia

Algolia Personalization API

Base URLs Base URLs for the Personalization API: https://personalization.us.algolia.com https://personalization.eu.algolia.com Use the URL that matches your…

Developer tools#openapi

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

  • https://personalization.us.algolia.com
  • https://personalization.eu.algolia.com

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

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.

Request format

Request bodies must be JSON objects.

Response status and errors

The Personalization 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.

Rate limiting

When making requests to the Personalization API, you are limited to 40 API calls per second per application.

The following headers provide information about your current limit:

  • x-ratelimit-limit: The number of requests allowed every second.
  • x-ratelimit-remaining: The number of requests remaining in the current

second period.

  • x-ratelimit-reset: Timestamp when the next time period starts, measured in seconds since the Unix epoch.

Version

The current version of the Personalization API is version 1, indicated by the /1/ in each endpoint's URL.

Endpoints 9

personalization

  • 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.
  • GETRetrieve a user profile/1/profiles/personalization/:userTokenRetrieves a user profile and their affinities for different facets.
  • DELETEDelete a user profile/1/profiles/:userTokenDeletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
  • GETRetrieve the personalization strategy/1/strategies/personalizationRetrieves the current personalization strategy.
  • POSTDefine the personalization strategy/1/strategies/personalizationCreates a new personalization strategy.
  • GETSwitch the API key used to authenticate requests/setClientApiKey?apiKey=stringSwitch the API key used to authenticate requests.

API details

Base URL
https://personalization.{region}.algolia.com
Authentication
An API key in the x-algolia-application-id header
An API key in the x-algolia-api-key header
Operations
9 operations on 5 pathsGET 4POST 2DELETE 2PUT 1
Main resources
personalization 9
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0.0

How to test the Algolia Personalization API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Algolia Personalization API collection, without the publisher's secrets.
  3. 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.
  4. 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 Personalization API?

Base URLs Base URLs for the Personalization API: https://personalization.us.algolia.com https://personalization.eu.algolia.com Use the URL that matches your… It is listed under Developer tools and has 9 endpoints.

Who publishes the Algolia Personalization 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 Personalization API?

Requests go to https://personalization.{region}.algolia.com. Endpoint paths are added to this base URL.

How do I authenticate with the Algolia Personalization 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 Personalization API have?

9 operations on 5 paths (4 GET, 2 POST, 2 DELETE, 1 PUT). The largest groups are personalization.

Is forking the Algolia Personalization API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.