The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content
Documentation Powered by Redocly

Predict API (1.0.0)

Download OpenAPI specification:Download

API powering the Predict feature of Algolia.

Profiles

Manage users' profiles.

Get user profile

Get predictions, properties (raw, computed or custom) and segments (computed or custom) for a user profile.

Authorizations:
(appIdapiKey)
path Parameters
userID
required
string

User ID for authenticated users or cookie ID for non-authenticated repeated users (visitors).

Request Body schema: application/json
One of
modelsToRetrieve
Array of strings (modelsToRetrieve)
Items Enum: "funnel_stage" "order_value" "affinities"

Responses

Request samples

Content type
application/json
Example
{
  • "modelsToRetrieve": [
    ]
}

Response samples

Content type
application/json
{
  • "user": "string",
  • "predictions": {
    },
  • "properties": {
    },
  • "segments": {
    }
}

Delete user profile

Delete all data and predictions associated with an authenticated user (userID) or an anonymous user (cookieID, sessionID).

Authorizations:
(appIdapiKey)
path Parameters
userID
required
string

User ID for authenticated users or cookie ID for non-authenticated repeated users (visitors).

Responses

Response samples

Content type
application/json
{
  • "user": "string",
  • "deletedUntil": "string"
}

Get all user profiles

Get all users with predictions in the provided application.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
One of
modelsToRetrieve
Array of strings (modelsToRetrieve)
Items Enum: "funnel_stage" "order_value" "affinities"

Responses

Request samples

Content type
application/json
Example
{
  • "modelsToRetrieve": [
    ]
}

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "previousPageToken": "string",
  • "nextPageToken": "string"
}