Export API
Get export configuration
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
Export API
Get export configuration
GET
/
api
/
recommendation
/
v1.0
/
customer
/
{customerId}
/
ExportConfiguration
/
{exportConfigurationId}
/
extended
curl --request GET \
--url https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/ExportConfiguration/{exportConfigurationId}/extended \
--header 'Authorization: Bearer <token>'
{
"meta": {
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"validation": [
{
"property": "<string>",
"message": "<string>"
}
],
"info": {}
},
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset": "<string>",
"scoreAggregationFields": [
{
"alias": "<string>",
"entityType": 1,
"fieldType": 0,
"originalName": "<string>",
"dataType": 1
}
],
"displayFields": [
{
"alias": "<string>",
"destinationName": "<string>",
"entityType": 1,
"fieldType": 0,
"originalName": "<string>",
"dataType": 1
}
],
"rankingRule": {
"sortingFields": [
{
"alias": "<string>",
"entityType": 1,
"fieldType": 0,
"direction": 0,
"originalName": "<string>",
"dataType": 1
}
],
"previousExportsFilter": {
"appearancesCount": 32768,
"daysCount": 32768
},
"previousResponseFilter": [
{
"responseTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"categoricalValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"boolValue": true,
"numericValue": 123,
"operator": 1,
"daysCount": 32768,
"occurrencesCount": 32768,
"responseType": "<string>",
"categoricalValue": "<string>"
}
]
},
"predictionScoresPerContactCount": 123,
"predictionScoresPerContactPerClassCount": [
{
"className": "<string>",
"predictionScoresPerClassCount": 123
}
],
"webhookName": "<string>",
"destination": 1,
"bigQueryDestination": {
"serviceAccountKey": "<string>",
"projectId": "<string>",
"datasetId": "<string>",
"table": "<string>",
"writeMode": 1
},
"activeCampaignDestination": {
"url": "<string>",
"secret": "<string>",
"prefix": "<string>",
"lists": [
"<string>"
]
},
"agillicDestination": {
"developerKey": "<string>",
"secret": "<string>",
"table": "<string>"
},
"microsoftSqlServerDestination": {
"host": "<string>",
"userId": "<string>",
"password": "<string>",
"database": "<string>",
"table": "<string>",
"isActiveDirectoryAuthentication": true
},
"sftpServerDestination": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"portNumber": 123,
"fingerprint": "<string>",
"path": "<string>"
},
"microsoftDynamicsDestination": {
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationUrl": "<string>",
"secret": "<string>",
"entity": "<string>",
"entityCollectionName": "<string>",
"contactRelationshipSchemaName": "<string>"
},
"lastSynchronization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"exportConfigurationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataflowJobId": "<string>",
"status": 0,
"exportedFilesCount": 123,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"fileNames": [
"<string>"
]
},
"predictionConfigurations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"contactTypes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
200
text/plain
OK
Minimum length:
1
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
0
, 1
, 2
, 3
, 4
, 5
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
Minimum length:
1
Minimum length:
1
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
0
, 1
, 2
, 3
, 4
, 5
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
Minimum length:
1
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 11
, 12
, 13
, 14
, 17
, 18
, 19
Available options:
0
, 1
, 2
, 3
, 4
, 5
Available options:
0
, 1
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
Available options:
1
, 2
, 3
, 4
Required range:
1 <= x <= 65535
Required range:
1 <= x <= 65535
Available options:
1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
Available options:
0
, 1
, 2
, 20
, 100
curl --request GET \
--url https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/ExportConfiguration/{exportConfigurationId}/extended \
--header 'Authorization: Bearer <token>'
{
"meta": {
"errors": [
{
"code": "<string>",
"message": "<string>"
}
],
"validation": [
{
"property": "<string>",
"message": "<string>"
}
],
"info": {}
},
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset": "<string>",
"scoreAggregationFields": [
{
"alias": "<string>",
"entityType": 1,
"fieldType": 0,
"originalName": "<string>",
"dataType": 1
}
],
"displayFields": [
{
"alias": "<string>",
"destinationName": "<string>",
"entityType": 1,
"fieldType": 0,
"originalName": "<string>",
"dataType": 1
}
],
"rankingRule": {
"sortingFields": [
{
"alias": "<string>",
"entityType": 1,
"fieldType": 0,
"direction": 0,
"originalName": "<string>",
"dataType": 1
}
],
"previousExportsFilter": {
"appearancesCount": 32768,
"daysCount": 32768
},
"previousResponseFilter": [
{
"responseTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"categoricalValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"boolValue": true,
"numericValue": 123,
"operator": 1,
"daysCount": 32768,
"occurrencesCount": 32768,
"responseType": "<string>",
"categoricalValue": "<string>"
}
]
},
"predictionScoresPerContactCount": 123,
"predictionScoresPerContactPerClassCount": [
{
"className": "<string>",
"predictionScoresPerClassCount": 123
}
],
"webhookName": "<string>",
"destination": 1,
"bigQueryDestination": {
"serviceAccountKey": "<string>",
"projectId": "<string>",
"datasetId": "<string>",
"table": "<string>",
"writeMode": 1
},
"activeCampaignDestination": {
"url": "<string>",
"secret": "<string>",
"prefix": "<string>",
"lists": [
"<string>"
]
},
"agillicDestination": {
"developerKey": "<string>",
"secret": "<string>",
"table": "<string>"
},
"microsoftSqlServerDestination": {
"host": "<string>",
"userId": "<string>",
"password": "<string>",
"database": "<string>",
"table": "<string>",
"isActiveDirectoryAuthentication": true
},
"sftpServerDestination": {
"host": "<string>",
"username": "<string>",
"password": "<string>",
"portNumber": 123,
"fingerprint": "<string>",
"path": "<string>"
},
"microsoftDynamicsDestination": {
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationUrl": "<string>",
"secret": "<string>",
"entity": "<string>",
"entityCollectionName": "<string>",
"contactRelationshipSchemaName": "<string>"
},
"lastSynchronization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"exportConfigurationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataflowJobId": "<string>",
"status": 0,
"exportedFilesCount": 123,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"fileNames": [
"<string>"
]
},
"predictionConfigurations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"contactTypes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
}
}