post https://api.personetics.com/pserver/execute
This call is made to get the user insights inbox.
Response
| Parameter | Type | Description | Mandatory |
|---|---|---|---|
| id | string | Instance ID | yes |
| text | string | Simple teaser to display (when no rich teaser is present) | no |
| insightId | string | Insight ID | yes |
| useCaseId | string | Specific use case of the insight ID | yes |
| segment | string | The determined user segment (insight configuration channel) the insight was generated with | no |
| businessId | string | In case insight is generated for a specific business of the user, the business name will appear here (only for applicable insights and users) | no |
| lineOfBusiness | string | The relevant line of business the insight belongs to (consumer, business, etc.) according to available values in project | no |
| insightType | string | Type of insight source (STORY\FLOW - case sensitive) | yes |
| status | string | Indicates if the insight was read by user in the past (read, unread, new) | yes |
| generatedDate | string | Date insight was generated for display (today, yesterday, etc.) | yes |
| presentedDate | date | Date insight was first presented | no |
| selectedDate | date | Date insight was selected (read) | no |
| displayDate | string | Recommended date to display in client | no |
| category1 | string | Categorizations and tags will be kept here. | no |
| category2 | string | Categorizations and tags will be kept here. | no |
| category3 | string | Categorizations and tags will be kept here. | no |
| score | number | Insight score | no |
| type | string | Insight class (Inform, improve, act) | no |
| userTag | string | Based on the preference object, the insight will be tagged. If no preference defined, this parameter will be returned as an empty string. | No |
| behaviorGroup | string | Indicates which behavior group this insight belongs to | no |
| highlighted | boolean | Indicates whether user\Insight provider chose this insight to be highlighted in list (true\false) | No |
| teaserTemplate | string | The name of rich teaser template to use, affects the teaserBlock array properties | no |
| teaserBlocks** | object | Dynamic array of properties that changes per template, see specific template. In case of templates, a blockId is added to each block in the array | no |
| customData | object | Object containing extra parameter per insight, specific per project. Will arrive only if developed in project | no |
| facts | object | Dynamic array of facts that change per insight. The facts hold all the user data that may be used to generate story or teaser for the insight. Fact per insight documentation is provided separately | no |
| actions | object | Dynamic array that can be used to store information and commands that can be performed in button blocks | no |
**teaserBlocks Object - Contains the definition of the visual blocks that build the teaser. Each “teaserTemplate” has a fixed set of blocks in the response, the list can be found here. The blocks parameters are found here.
In custom cases where there is no template defined, the teaser is built by the list of blocks and the layout instructions.