get/api/v2/responses/summary
Return response summary analytics.
Return response summary analytics.
Requires bearer API keyParameters
| Name | In | Description |
|---|---|---|
| X-Project-Id | header | Required for organization-wide API keys on project-scoped endpoints. Project-scoped keys infer the project automatically.string |
| startDate | query | No description provided.string:date-time |
| endDate | query | No description provided.string:date-time |
| monitorIds | query | Comma-separated values are accepted.string |
| promptIds | query | Comma-separated values are accepted.string |
| modelIds | query | Comma-separated values are accepted.string |
| brandIds | query | Comma-separated values are accepted.string |
| sentiments | query | Comma-separated values are accepted.string |
| tags | query | Comma-separated values are accepted.string |
Responses
200
application/jsonSuccessful JSON response.
{
"type": "object",
"additionalProperties": true,
"properties": {
"totalResponses": {
"type": "integer"
},
"totalMentions": {
"type": "integer"
},
"brandMentionRate": {
"type": "number"
},
"totalCitations": {
"type": "integer"
},
"avgVisibility": {
"type": "integer"
},
"avgSentiment": {
"type": "integer"
}
},
"required": [
"totalResponses",
"totalMentions",
"brandMentionRate",
"totalCitations",
"avgVisibility",
"avgSentiment"
]
}Try it
Send this request to the local WatchLLM REST handler. Use a key from /workspace/api; organization keys can include X-Project-Id only when the endpoint documents that header.