Model API
Get models
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
Model API
Get models
GET
/
api
/
model
/
v1.0
/
customer
/
{customerId}
/
model_v2_1
curl --request GET \
--url https://app.allyy.io/api/model/v1.0/customer/{customerId}/model_v2_1 \
--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>",
"title": "<string>",
"description": "<string>",
"type": 1,
"status": 1,
"modelTrainingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trainingStatus": 1,
"trainingStarted": "2023-11-07T05:31:56Z",
"trainingFinished": "2023-11-07T05:31:56Z",
"trainingErrorCode": 123,
"auRoc": 123,
"responsePredictionConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"contactTypes": [
"<string>"
],
"contactSegments": [
"<string>"
],
"responseValues": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"isPositive": true
}
],
"responsePredictionFeaturesCriterias": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"includedFixedPeriods": [
1
],
"includeRelativePeriods": true
}
],
"includeSubscriptionChangesFeatures": true,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"cutOffPeriod": 123,
"daysToLastCutOffEnd": 123,
"optimizationObjective": 1,
"shuffleData": true,
"dataSplit": {
"test": 123,
"evaluation": 123,
"train": 123
}
},
"churnConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"cutOffPeriodInDays": 123,
"daysToLastCutOffEnd": 123,
"numberOfPeriods": 123,
"contactTypes": [
"<string>"
],
"churnResponseFeaturesCriterias": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"includedFixedPeriods": [
1
],
"includeRelativePeriods": true
}
],
"subscriptionChangesFeaturesIncluded": true,
"durationMore": 123,
"durationLess": 123,
"optimizationObjective": 1,
"shuffleData": true,
"dataSplit": {
"test": 123,
"evaluation": 123,
"train": 123
}
},
"recommenderSystemConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"cutOffPeriod": 123,
"daysToLastCutOffEnd": 123,
"responseValues": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"weight": 123
}
],
"previousResponseSequenceSize": 123
}
}
],
"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
, 4
, 5
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 20
, 100
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
1
, 2
, 3
, 4
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.responseValue.responseType
string | null
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.responseValue.categoricalValue
string | null
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.responseValue.numericValue
number | null
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.responseValue.boolValue
boolean | null
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.responseValue.operator
enum<integer>
Available options:
1
, 2
, 3
, 4
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.includedFixedPeriods
enum<integer>[] | null
Available options:
1
, 2
, 3
, 4
data.responsePredictionConfiguration.responsePredictionFeaturesCriterias.includeRelativePeriods
boolean
Available options:
1
, 2
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
data.churnConfiguration.churnResponseFeaturesCriterias.responseValue.categoricalValue
string | null
Available options:
1
, 2
, 3
, 4
data.churnConfiguration.churnResponseFeaturesCriterias.includedFixedPeriods
enum<integer>[] | null
Available options:
1
, 2
, 3
, 4
Available options:
1
, 2
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
1
, 2
, 3
, 4
curl --request GET \
--url https://app.allyy.io/api/model/v1.0/customer/{customerId}/model_v2_1 \
--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>",
"title": "<string>",
"description": "<string>",
"type": 1,
"status": 1,
"modelTrainingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trainingStatus": 1,
"trainingStarted": "2023-11-07T05:31:56Z",
"trainingFinished": "2023-11-07T05:31:56Z",
"trainingErrorCode": 123,
"auRoc": 123,
"responsePredictionConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"contactTypes": [
"<string>"
],
"contactSegments": [
"<string>"
],
"responseValues": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"isPositive": true
}
],
"responsePredictionFeaturesCriterias": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"includedFixedPeriods": [
1
],
"includeRelativePeriods": true
}
],
"includeSubscriptionChangesFeatures": true,
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"cutOffPeriod": 123,
"daysToLastCutOffEnd": 123,
"optimizationObjective": 1,
"shuffleData": true,
"dataSplit": {
"test": 123,
"evaluation": 123,
"train": 123
}
},
"churnConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"cutOffPeriodInDays": 123,
"daysToLastCutOffEnd": 123,
"numberOfPeriods": 123,
"contactTypes": [
"<string>"
],
"churnResponseFeaturesCriterias": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"includedFixedPeriods": [
1
],
"includeRelativePeriods": true
}
],
"subscriptionChangesFeaturesIncluded": true,
"durationMore": 123,
"durationLess": 123,
"optimizationObjective": 1,
"shuffleData": true,
"dataSplit": {
"test": 123,
"evaluation": 123,
"train": 123
}
},
"recommenderSystemConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": "<string>",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSet": "<string>",
"name": "<string>",
"description": "<string>",
"entity": 1,
"entityLists": [
"<string>"
],
"classes": [
{
"name": "<string>",
"value": "<string>"
}
],
"excludedAttributes": [
{
"entityType": 1,
"alias": "<string>",
"originalName": "<string>"
}
],
"excludedClasses": [
{
"entityType": 1,
"className": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"cutOffPeriod": 123,
"daysToLastCutOffEnd": 123,
"responseValues": [
{
"responseValue": {
"responseType": "<string>",
"categoricalValue": "<string>",
"numericValue": 123,
"boolValue": true,
"operator": 1
},
"weight": 123
}
],
"previousResponseSequenceSize": 123
}
}
],
"totalItemsCount": 123
}