Insights
The Insights module performs synchronous analysis of the received data, returning score, status, and insights within a few seconds.
How the Insights Module Works
Insights Module WorksThe Insights module operates synchronously, analyzing the data immediately after receiving a request. This process involves cross-referencing multiple relevant pieces of information to calculate the score, determine the status, and provide the insights of the analysis.
The analysis response is returned within seconds, enabling quick insightss that are integrated into the application's flow, without the need for asynchronous processing or prolonged waiting.
Response POST
Represents the execution response of the integration. If you have contracted more than one module, you may receive all at once. Any module not contracted will not be returned.
Result
| Fields | Description | Type | Required |
|---|---|---|---|
| executionId | Execution ID | Guid | Yes |
| analysisId | Analysis ID | Guid | Yes |
| transactionId | Transaction ID | String | Yes |
| insights | Insights results | Insights Result | No |
Insights Result
Represents the insights generated by the analysis.
| Fields | Description | Type | Required |
|---|---|---|---|
| status | Insights status | String | Yes |
| result | List of generated insights | Insight Array | No |
Insight
Represents an insight generated by the analysis.
| Fields | Description | Type | Required |
|---|---|---|---|
| code | Insight code | String | Yes |
| description | Insight description | String | Yes |
| type | Insight type | String | Yes |
| category | Insight category | String | Yes |
| relevance | Insight relevance | String | Yes |
| relatedTo | Entity or element related to the insight | String Array | Yes |
JSON
{
"executionId": "string",
"analysisId": "string",
"transactionId": "string",
"insights": {
"status": "string",
"result": [
{
"code": "string",
"description": "string",
"type": "string",
"category": "string",
"relevance": "string",
"relatedTo": [
"string"
]
}
]
}
}Response GET
Represents the execution response of the analysis query.
Result
| Fields | Description | Type | Required |
|---|---|---|---|
| analysisId | Analysis ID | Guid | Yes |
| transactionId | Transaction ID | String | Yes |
| insights | Insights results | Insights Result | No |
Insights Result
Represents the insights generated by the analysis.
| Fields | Description | Type | Required |
|---|---|---|---|
| status | Insights status | String | Yes |
| result | List of generated insights | Insight Array | No |
Insight
Represents an insight generated by the analysis.
| Fields | Description | Type | Required |
|---|---|---|---|
| code | Insight code | String | Yes |
| description | Insight description | String | Yes |
| type | Insight type | String | Yes |
| category | Insight category | String | Yes |
| relevance | Insight relevance | String | Yes |
| relatedTo | Entity or element related to the insight | String Array | Yes |
JSON
{
"analysisId": "string",
"transactionId": "string",
"insights": {
"status": "string",
"result": [
{
"code": "string",
"description": "string",
"type": "string",
"category": "string",
"relevance": "string",
"relatedTo": [
"string"
]
}
]
}
}Response Error
Represents the details of a problem returned by the API in case of an error.
| Fields | Description | Type | Required |
|---|---|---|---|
| type | URI that identifies the specific problem type. Can be used to categorize the error. | String | No |
| title | Descriptive title of the problem | String | Yes |
| status | HTTP status code associated with the problem | Integer | Yes |
| errors | Validation errors | Object | Yes |
| instance | URI that identifies the specific instance of the problem | String | No |
HTTP Status Codes
Represents the possible HTTP codes returned by the API in case of an error.
| Code | Name | Meaning |
|---|---|---|
| 400 | Bad Request | The request was malformed or contains invalid parameters |
| 401 | Unauthorized | The client is not authenticated or the token is invalid/expired |
| 500 | Internal Server Error | An unexpected error occurred on the server |
| 503 | Service Unavailable | The service is temporarily unavailable or under maintenance |
JSON
{
"errors": {
"string": [
"string"
]
},
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "string"
}{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Internal server error",
"status": 500,
"detail": "The server encountered an unexpected condition that prevented it from fulfilling the request",
"traceId": "string"
}Updated about 2 months ago