GET
/
api
/
recommendation
/
v1.0
/
customer
/
{customerId}
/
ExportConfiguration
curl --request GET \
  --url https://app.allyy.io/api/recommendation/v1.0/customer/{customerId}/ExportConfiguration \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "errors": [
      {
        "code": "<string>",
        "message": "<string>"
      }
    ],
    "validation": [
      {
        "property": "<string>",
        "message": "<string>"
      }
    ],
    "info": {}
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "datasetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dataset": "<string>",
      "predictionConfigurationIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "contactTypeIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "rankingRule": {
        "sortingFields": [
          {
            "displayField": {
              "alias": "<string>",
              "entityType": 1,
              "fieldType": 0
            },
            "direction": 0
          }
        ],
        "previousExportsFilter": {
          "appearancesCount": 123,
          "daysCount": 123
        },
        "previousResponseFilter": [
          {
            "responseTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "categoricalValueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "boolValue": true,
            "numericValue": 123,
            "operator": 1,
            "daysCount": 123,
            "occurrencesCount": 123
          }
        ]
      },
      "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>"
      },
      "googleCloudStorageDestination": {
        "fileUrl": "<string>",
        "serviceAccountKey": "<string>"
      },
      "microsoftDynamicsDestination": {
        "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "organizationUrl": "<string>",
        "secret": "<string>",
        "entity": "<string>",
        "entityCollectionName": "<string>",
        "contactRelationshipSchemaName": "<string>"
      },
      "scoreAggregationFields": [
        {
          "alias": "<string>",
          "entityType": 1,
          "fieldType": 0
        }
      ],
      "displayFieldMappings": [
        {
          "displayField": {
            "alias": "<string>",
            "entityType": 1,
            "fieldType": 0
          },
          "destinationName": "<string>"
        }
      ]
    }
  ],
  "totalItemsCount": 123
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

customerId
string
required
version
string
required

Query Parameters

dataSetIds
string[]
modelType
enum<integer>
Available options:
1,
2,
3,
4,
5,
6
destination
integer[]
orderBy
string
orderByDesc
boolean
take
integer
skip
integer

Response

200
text/plain
OK
meta
object
data
object[] | null
totalItemsCount
integer