Create predictive scoring model (legacy)

Create a new predictive scoring model.
This endpoint is for Audience Studio legacy. For the latest Audience Studio, contact your Customer Success Representative.

SecurityTdApikeyAuth
Request
path Parameters
audienceId
required
integer <int64>

Master Segment id of the preditive segment

Request Body schema: application/json
required

Predictive Segment parameters to create

name
string
description
string or null
baseSegmentId
integer or null <int64>
segmentId
integer <int64>
scoredSegmentId
integer or null <int64>
gradeThresholds
Array of numbers <double> (PredictiveSegmentGradeThresholds) = 3 items

Given the items [a, b, c], they must meet the condition a >= b >= c

categoricalAsColumnNames
Array of strings
categoricalArrayAsColumnNames
Array of strings
quantitativeAsColumnNames
Array of strings
Array of objects (PredictiveSegmentPreprocessItem) non-empty

Definition of preprocess. All of $item.column must be specified in one of categoricalAsColumnNames, categoricalArrayAsColumnNames, or quantitativeAsColumnNames.

Responses
200

successful operation

400

Given parameters are not valid

401

Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource was not found

4XX

There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

post/audiences/{audienceId}/predictive_segments
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "baseSegmentId": 0,
  • "segmentId": 0,
  • "scoredSegmentId": 0,
  • "gradeThresholds": [
    ],
  • "categoricalAsColumnNames": [
    ],
  • "categoricalArrayAsColumnNames": [
    ],
  • "quantitativeAsColumnNames": [
    ],
  • "preprocess": [
    ]
}
Response samples
application/json
{
  • "audienceId": "string",
  • "id": "string",
  • "baseSegmentId": "string",
  • "segmentId": "string",
  • "scoredSegmentId": "string",
  • "name": "string",
  • "description": "string",
  • "categoricalAsColumnNames": [
    ],
  • "categoricalArrayAsColumnNames": [
    ],
  • "quantitativeAsColumnNames": [
    ],
  • "accuracy": 100,
  • "areaUnderRocCurve": 1,
  • "gradeThresholds": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}