An AnalysisRequest object contains all the data related to an analysis request.
| Attribute | Type | Required | Description |
|---|---|---|---|
| text | String | true | The text message to analyze. |
| publishedAt | Date | false | The message publication date (on your platform). Default to now. |
| context | Context | false | Some context information that enable powerful features such as spam detection and analytics computing (this will be reflected on your dashboard). |
| reference | String | false | A custom unique identifier for this AnalysisRequest. Auto-generated by default. |
| language | String | false | The message language (ISO 639-1). If set, the analysis will be forced in the specified language. Otherwise, the language will be auto-detected. |
| defaultLanguage | String | false | Useless if language param is set. This value is used when language auto-detection fail. |
- Text max length is limited to 1000 characters by default, and can be customized for each clients upon request at business@bodyguard.ai.
- Each message reference is unique by channel. This means that if you set the same reference multiple times on a given channel, updates will be applied instead of creation.
Important notes about the publishedAt field:
-
It CANNOT be updated. If you analyze the same Message (with an existing
reference) multiple times, thepublishedAtfield will NOT be updated even if specified again. -
It CANNOT be older than 6 month.
Context
This object allows you to benefit from advanced analyzer services.
| Attribute | Type | Required | Description |
|---|---|---|---|
| topLevelReference | String | false | Allows you to link this message to the top level message. Example: e.g first/original post. |
| parentReference | String | false | Allows you to link this message to a parent message. |
| permalink | String | false | Allows you to link the analyzed message to the original message on the platform. This link will be displayed on our dashboard. |
| from | AuthorContext | false | Allows you to add any user sender details. This fields is very important for the spam detection and other advanced features. |
| to | AuthorContext | false | Allows you to add any user receiver details. |
| post | PostContext | false | Allows you to add any post details. |
Author context
| Attribute | Type | Required | Description |
|---|---|---|---|
| type | AuthorType | true | Author type. |
| data | Author | false | The author's details. Not applicable for ANONYMOUS type. Contains informations regarding a user involved in the AnalysisRequest (sender or receiver). |