get
https://partner.gupshup.io/partner/app//bizai/agent-eval/details
Per-conversation results. 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. |
eval_ids | string | Yes | Query | Comma-separated evaluation ids. |
Example request
curl --location --request GET 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent-eval/details?eval_ids=pfbid0FirstExampleId,pfbid0SecondExampleId' \
--header 'Authorization: <PARTNER_APP_TOKEN>'Response parameters — 200
200| Parameter | Type | Description |
|---|---|---|
evaluations | array of object | Per-conversation evaluations. |
evaluations[].id | string | Resource id. |
evaluations[].score | integer | Conversation score. |
evaluations[].per_turn_labels | string | JSON string |
evaluations[].reasons | string | JSON string |
evaluations[].custom_success_criteria | string | Criteria set for this case. |
evaluations[].eval_case_id | string | Case the evaluation ran. |
evaluations[].transcript | string | JSON string |
evaluations[].creation_time | integer | Creation time, Unix seconds. |
evaluations[].update_time | integer | Last update time, Unix seconds. |
Example response — 200 OK
200 OK{
"evaluations": [
{
"id": "pfbid0EvaluationExampleId",
"score": 4,
"per_turn_labels": "[\"good\", \"good\", \"needs_improvement\"]",
"reasons": "[\"Answered accurately\", \"Missed the order id\"]",
"custom_success_criteria": "Agent confirms the refund amount",
"eval_case_id": "pfbid0EvalCaseExampleId",
"transcript": "[{\"role\": \"user\", \"text\": \"Where is my order?\"}]",
"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.