Get Scores Breakdown

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

Returns sentiment score breakdowns segmented by a specified tag key.
Each result entry represents a distinct tag value within that key,
with its positive/negative/neutral distribution.

  • surveyInstanceId (string, required) — Survey instance to query

  • endDate (string/date, required) — End of the date range

  • tagKey (string, required) — The tag dimension to break down scores
    by (e.g. demographic, region)

  • startDate (string/date, optional) — Start of the date range

  • aspectId (string, optional) — Filter results to a specific aspect

  • questionId (string, optional) — Filter results to a specific
    question

  • tags (optional) — Additional tag filters to apply

    Response: ScoresBreakdownResponse[] — an array of entries, each
    containing:

  • tagKey — the tag dimension

  • tagValue — the specific tag value for this segment

  • tagLabel — human-readable label for the tag value

  • breakdown — sentiment distribution with positive, negative, and
    neutral scores

Query Params
string

Post Interaction Survey Id

date

Start Date ISO format e.g. 2026/02/25

date

Start Date ISO format e.g. 2026/02/27

json

Represents the filter tags {"serviceType": ["id1", "id2", ...]}

string

The Aspect id to filter on

string

Provide the tag key (filter category) to retrieve the scores for it. e.g. "serviceType"

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json