get
https://partner.gupshup.io/partner/app//bizai/agent-eval/summary
Aggregated insight reports. Unknown ids return 200 with an empty result.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request parameters
| Parameter | Type | Required | In | Description |
|---|---|---|---|---|
Authorization | string | Yes | Header | Partner app token, sent raw. Bearer <token> is also accepted. |
appId | string (uuid) | Yes | Path | Partner Portal app id. Stands in for Meta's entity_id. |
summary_ids | string | Yes | Query | Comma-separated summary ids. |
Example request
curl --location --request GET 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent-eval/summary?summary_ids=pfbid0FirstExampleId,pfbid0SecondExampleId' \
--header 'Authorization: <PARTNER_APP_TOKEN>'Response parameters — 200
200| Parameter | Type | Description |
|---|---|---|
insights | array of object | Aggregated insight reports. |
insights[].id | string | Resource id. |
insights[].summary_id | string | Summary id, for GET /agent-eval/summary. |
insights[].avg_conversation_score | number | Range 1–5. |
insights[].avg_turn_score | number | Range 1–5. |
insights[].summary | string | Narrative summary. |
insights[].highlights | string | JSON string |
insights[].top_failure_categories | string | JSON string |
insights[].eval_ids_by_score | string | JSON string |
insights[].creation_time | integer | Creation time, Unix seconds. |
insights[].update_time | integer | Last update time, Unix seconds. |
Example response — 200 OK
200 OK{
"insights": [
{
"id": "pfbid0EvaluationExampleId",
"summary_id": "pfbid0SummaryExampleId",
"avg_conversation_score": 4.2,
"avg_turn_score": 4.2,
"summary": "Agent resolved most refund requests; escalations were slow.",
"highlights": "[\"Fast first response\"]",
"top_failure_categories": "[\"missing_context\"]",
"eval_ids_by_score": "{\"5\": [\"pfbid0EvalExampleId\"]}",
"creation_time": 1789630852,
"update_time": 1789630852
}
]
}Error responses
400 Bad Request — The app is not live, or WASS does not consider it live.
{
"message": "App is not live.",
"status": "error"
}400 Bad Request — The app has no phone number attached. Checked before the live check.
{
"message": "Phone id not found for the given App",
"status": "error"
}401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.
{
"status": "error",
"message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.
{
"status": "error",
"message": "Request method 'PATCH' is not supported"
}429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.
{
"status": "error",
"message": "Too Many Requests"
}Per-app rate limit exceeded. Retry after the 60-second window.