Prediction API
Get predictions
API Documentation
Data API
- GETGet datasets
- GETGet datasources
- GETGet datasource
- GETGet datasource uploads
- POSTStart ActiveCampaign synchronization
- POSTStart Agillic synchronization
- POSTStart Big Query synchronization
- POSTUpload CSV file
- POSTStart Google Analytics 4 synchronization
- POSTStart Google Cloud Storage synchronization
- POSTUpload JSON file
- POSTStart MSSQL synchronization
- POSTStart Naviga synchronization
- POSTStart SFTP synchronization
Model API
- GETGet models
- GETGet model
- GETGet model trainings
- POSTStart model training
- GETGet model training statistics: feature impact
- GETGet model training statistics: beeswarm
- GETGet model training statistics: feature dependence
- GETGet model training statistics: feature dependence with secondary feature
- GETGet model training statistics: waterfall data
Prediction API
Export API
Recommendation API
Prediction API
Get predictions
GET
/
api
/
prediction
/
v1.0
/
customer
/
{customerId}
/
predictionV21
curl --request GET \
--url https://app.allyy.io/api/prediction/v1.0/customer/{customerId}/predictionV21 \
--header 'Authorization: Bearer <token>'
{
"meta": {
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"validation": [
{
"property": "<string>",
"message": "<string>"
}
],
"info": {}
},
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"type": 1,
"entityType": 1,
"models": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"execution": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 1,
"started": "2023-11-07T05:31:56Z",
"finished": "2023-11-07T05:31:56Z"
},
"recommenderSystemData": {
"contactSegments": [
"<string>"
],
"entityLists": [
"<string>"
],
"predictionLists": [
"<string>"
]
},
"churnData": {
"contactSegments": [
"<string>"
],
"daysToFirstCutOffStart": 123
},
"responsePredictionData": {
"contactSegments": [
"<string>"
],
"entityLists": [
"<string>"
],
"predictionLists": [
"<string>"
]
}
}
],
"totalItemsCount": 123
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Response
200
text/plain
OK
Available options:
1
, 2
, 3
, 4
, 5
, 6
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
curl --request GET \
--url https://app.allyy.io/api/prediction/v1.0/customer/{customerId}/predictionV21 \
--header 'Authorization: Bearer <token>'
{
"meta": {
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"validation": [
{
"property": "<string>",
"message": "<string>"
}
],
"info": {}
},
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"type": 1,
"entityType": 1,
"models": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"execution": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 1,
"started": "2023-11-07T05:31:56Z",
"finished": "2023-11-07T05:31:56Z"
},
"recommenderSystemData": {
"contactSegments": [
"<string>"
],
"entityLists": [
"<string>"
],
"predictionLists": [
"<string>"
]
},
"churnData": {
"contactSegments": [
"<string>"
],
"daysToFirstCutOffStart": 123
},
"responsePredictionData": {
"contactSegments": [
"<string>"
],
"entityLists": [
"<string>"
],
"predictionLists": [
"<string>"
]
}
}
],
"totalItemsCount": 123
}