Predict API (0.1.0)

Download OpenAPI specification:Download

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

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

modelsToRetrieve	Array of strings (modelsToRetrieve) Items Enum: "funnel_stage" "order_value" "affinities" List with model types for which to retrieve predictions.
typesToRetrieve	Array of strings (typesToRetrieve) non-empty Items Enum: "properties" "segments" List with types to be retrieved.

Responses

Request samples

Payload

Content type

application/json

{"modelsToRetrieve": ["funnel_stage"
],
"typesToRetrieve": ["properties"
]
}

Response samples

200
400
404
405

Content type

application/json

{"user": "string",
"predictions": {"funnel_stage": {"value": [{"name": "string",
"probability": 1
}
],
"lastUpdatedAt": "string"
},
"order_value": {"value": 0,
"lastUpdatedAt": "string"
},
"affinities": {"value": [{"name": "string",
"value": "string",
"probability": 1
}
],
"lastUpdatedAt": "string"
}
},
"properties": {"raw": { },
"computed": { },
"custom": { }
},
"segments": {"computed": ["string"
],
"custom": ["string"
]
}
}