Get export configuration (extended)
curl --request GET \
--url https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>",
"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>"
]
},
"predictionConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"contactTypes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
],
"targetGroup": {
"criteriaList": [
{
"name": "<string>",
"ratio": 123,
"count": 123,
"mode": 1
}
],
"groupScoresByContact": true,
"isRelative": true
}
}
}Export API
Get export configuration
Returns extended export configuration details including last synchronization info.
Note: The response schema shown below applies when exportType is prediction. When exportType is decision, the response shape differs: instead of displayFields, rankingRule, predictionScores, contactTypes, and targetGroup, it contains decisionConfigurationId, decisionConfiguration (id + name), and fieldMappings.
GET
/
api
/
recommendation
/
v1.0
/
customer
/
{customerId}
/
{exportType}
/
ExportConfiguration
/
{exportConfigurationId}
/
extended
Get export configuration (extended)
curl --request GET \
--url https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/{exportType}/ExportConfiguration/{exportConfigurationId}/extended")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>",
"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>"
]
},
"predictionConfiguration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"contactTypes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
],
"targetGroup": {
"criteriaList": [
{
"name": "<string>",
"ratio": 123,
"count": 123,
"mode": 1
}
],
"groupScoresByContact": true,
"isRelative": true
}
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Scopes
oneprediction_api
Path Parameters
Export configuration type: prediction or decision