Explains the column in the data source

post/explain

Internal-Use Only

Explains the specified column in relation to the other columns in the data. The data is processed into human friendly sentences. This call is a GET via POST.

Request Samples

application/vnd.sas.insights.explain.definition
1

Response Samples

200
application/vnd.sas.insights.explain.result
1{
2  "version": 1,
3  "variableDescription": "A string that describes the specified column.",
4  "outlierDescription": "A string that describes the outliers of the specified column.",
5  "forecastDescription": "A string that describes the forecast of the specified column.",
6  "variableScreeningResults": [
7    {
8      "columnName": "columnName",
9      "label": "label",
10      "actionTaken": "The factor was rejected because it has too many missing values.",
11      "actionsTaken": [
12        "The measure was converted to category because relatively few distinct levels were detected.",
13        "The factor was rejected because it has too many missing values."
14      ],
15      "reasons": [
16        "MeasureLevelsDetected",
17        "TooManyMissingValues"
18      ]
19    }
20  ],
21  "warnings": [
22    {
23      "code": "NewEventLevelChosen",
24      "message": "The selected event level is no longer available. A new event level has been chosen."
25    }
26  ]
27}

Header Parameters

Name	Type	Required	Description
Accept-Language	string	false	The user's language, which is used to create the description strings. If this header is not set, the language will be the default language of the service.
Accept-Locale	string	false	A "format locale" that is distinct from the user's language (Accept-Language). Its syntax is similar to Accept-Language. It is used to format numeric values and provides a way for the numeric formatting to be different than the typical numeric formatting of the language. If this header is not set, the language locale will be used.

Request Body

Explain definition information

The definition of the explanation that you want to perform.

Name	Type	Required	Description
version	integer	false	The version of the schema. Example: 3
cas	Cas	true	The CAS resource specification.
targetVariable	string	true	The target variable column name in the table that you want to explain. Example: "columnName"
includeVariableDescription	boolean	false	An optional flag to generate the variable description. One of these variables must be true: includeVariableDescription or includeOutlierDescription. The default value is true. Example: true
includeOutlierDescription	boolean	false	An optional flag to generate the outlier description. One of these variables must be true: includeVariableDescription or includeOutlierDescription. The default value is false. Example: false
useMissing	boolean	false	An optional flag to tell you if missing values should be included in (true) or ignored by (false) the analysis. The default value is true. Example: false
dateVariable	string	false	The name of the time series column. When present, the time series column is used to generate forecast insights. Example: "Date"
includeVariableScreeningResults	boolean	false	An optional flag to generate the variable screening results. The default value is true. Example: false

Responses

Status	Meaning	Description
200	OK	The explanation of the column in relation to the other columns in the data.		Schema
400	Bad Request	Bad Request. The request body is not properly formed. This can happen for a variety of reasons including missing required fields in the body, troubles accessing the specified CAS table, and the specified column name is not in the CAS data source.		Schema