GET
/
api
/
model
/
v1.0
/
customer
/
{customerId}
/
model_v2_1
/
{modelId}
curl --request GET \
  --url https://app.allyy.io/api/model/v1.0/customer/{customerId}/model_v2_1/{modelId} \
  --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
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customerId
string
required
​
modelId
string
required
​
version
string
required

Response

200
text/plain

OK

The response is of type object.