Skip to main content
Documentation Powered by ReDoc

Predict API (0.1.0)

API powering the Predict feature of Algolia.

Authentication

appId

Security Scheme Type API Key
Header parameter name: X-Algolia-Application-Id

apiKey

Security Scheme Type API Key
Header parameter name: X-Algolia-API-Key

predict

Predict API reference

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:
appIdapiKey
path Parameters
path
required
string
Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters
parameters
string
Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Responses

Response samples

Content type
application/json
{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:
appIdapiKey
path Parameters
path
required
string
Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters
parameters
string
Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:
appIdapiKey
path Parameters
path
required
string
Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters
parameters
string
Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Send requests to the Algolia REST API.

This method allow you to send requests to the Algolia REST API.

Authorizations:
appIdapiKey
path Parameters
path
required
string
Example: /keys

The path of the API endpoint to target, anything after the /1 needs to be specified.

query Parameters
parameters
string
Example: parameters=?query=mySearchQuery&hitsPerPage=10

URL-encoded query string. Force some query parameters to be applied for each query made with this API key.

Request Body schema: application/json

The parameters to send with the custom request.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

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
modelsToRetrieve
Array of strings
Items Enum: "funnel_stage" "order_value" "affinities"

List with model types for which to retrieve predictions

typesToRetrieve
Array of strings non-empty
Items Enum: "properties" "segments"

List with types to be retrieved.

Responses

Request samples

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

Response samples

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