Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
customer_pulse
/
summary
Sentiment summary
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/customer_pulse/summary \
  --header 'api_access_token: <api-key>'
{
  "total_analyzed": 123,
  "positive_count": 123,
  "neutral_count": 123,
  "negative_count": 123,
  "positive_percentage": 123,
  "neutral_percentage": 123,
  "negative_percentage": 123,
  "average_score": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Response

Sentiment summary

​
total_analyzed
integer
​
positive_count
integer
​
neutral_count
integer
​
negative_count
integer
​
positive_percentage
number<float>
​
neutral_percentage
number<float>
​
negative_percentage
number<float>
​
average_score
number<float>