Get Satisfaction and Outcome Analytics

Retrieves satisfaction and outcome analytics for voice agents including NPS score, sentiment distribution, CSAT score, first call resolution, and escalation rate.

GET /v1/agent-analytics/satisfaction

Get Satisfaction and Outcome Analytics

cURL

curl --request GET \
  --url https://api.tryhamsa.com/v1/agent-analytics/satisfaction \
  --header 'Authorization: <api-key>'

200

{
  "success": true,
  "data": {
    "npsScore": 87,
    "sentimentDistribution": {
      "positive": 87,
      "neutral": 7,
      "negative": 6
    },
    "csatScore": 65,
    "firstCallResolutionPercentage": 77,
    "escalationRate": 33
  }
}

Authorizations

Authorization · string · header · required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

voiceAgentId · string<uuid>

The unique identifier of the voice agent. If not sent, the statistics will be for all voice agents.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

period · enum<string> · default: TODAY

The period filter option. Defaults to TODAY.

Available options: LAST_HOUR, TODAY, YESTERDAY, THIS_WEEK, THIS_MONTH, CUSTOM

Example:

"TODAY"

startPeriod · string

The start period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

Example:

"1737590399000"

endPeriod · string

The end period timestamp in milliseconds sent in string format. Must be sent with CUSTOM date filter.

Example:

"1737590399000"

timeDifference · string · default: 0

The time difference between the timezone of the user's machine to the UTC/GMT timezone.

Example:

"-3"

Response

200

application/json

Successful response

success · boolean

Example:

true

data · object

Show child attributes