Persists a reporting-chat exchange and generates KQL for querying report data
Use this endpoint for initial report prompts, refinements, and clarification selections. It persists the displayed user content and one assistant response but does not create or update a dynamic report. Execute successful KQL through the dynamic-report query endpoint and save explicitly through the dynamic-report endpoints.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| chatId | Unique numeric identifier of an active reporting chat owned by the authenticated user | integer (int32) | Required |
Request Body
WattsReportChatMessageCreate
| Property | Description | Type |
|---|---|---|
| clarificationOptions | Clarification options shown to the user. Null when no options were presented or this message is not a clarification response. | string[] |
| clarificationOriginalPrompt | Original user-facing prompt that produced a clarification question. Null when this message is not a clarification response. | string |
| clarificationQuestion | Clarification question shown to the user. Null when this message is not a clarification response. | string |
| content | User-facing message persisted verbatim in reporting chat history. Required | string |
| priorKql | KQL for the currently displayed report when this message refines an existing result. Null for an initial report request. | string |
Example Request Body
{ "clarificationOptions": [
"string"
], "clarificationOriginalPrompt": "string", "clarificationQuestion": "string", "content": "string", "priorKql": "string"
}Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
WattsReportChatResponse
| Property | Description | Type |
|---|---|---|
| clarificationOptions | The list of clarification options to be presented to the user if clarification is required | string[] |
| clarificationQuestion | The clarification question to be presented to the user if clarification is required | string |
| error | User-facing generation error. Empty when generation succeeds or requires clarification. | string |
| explanation | A message providing additional information about the report creation result | string |
| isSuccess | Indicates whether the report creation was successful | boolean |
| kql | KQL generated from the user prompt. Null when generation requires clarification or fails. | string |
| requiresClarification | Indicates whether the report creation requires clarification from the user | boolean |
| resolutionSteps | The list of resolution steps to be presented to the user if clarification is required | string[] |
| wattsChatMessageId | Unique numeric identifier of the assistant message persisted for this response. | integer (int32) |
Example Response
{ "clarificationOptions": [
"string"
], "clarificationQuestion": "string", "error": "string", "explanation": "string", "isSuccess": false, "kql": "string", "requiresClarification": false, "resolutionSteps": [
"string"
], "wattsChatMessageId": 1
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.