customer-engagement
vocalize
score

Get user score statistics

This endpoint retrieves score statistics for a specific user in a campaign.

get/vocalize/2/scores/stats

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Query parameters

campaignIdstring uuid required

ID of the campaign to get score stats for.

userIdstring required

User ID, a unique identifier for the user.

Response

Score stats successfully retrieved

positioninteger

Position of the participant on the leaderboard, taking into account tie-breaking.

rankinteger

Position of the participant on the leaderboard, not taking into account tie-breaking.

tiedWithinteger

Number of other participants tied with the same score.

bestScoreinteger

The highest score achieved by the participant in the campaign.

attemptsinteger required

Total number of attempts made by the participant in the campaign.

attemptsRemaininginteger required

Number of attempts remaining for the participant today.

nextScoreToBeatinteger

The next highest score the participant needs to beat to improve their ranking.

numberOfParticipantsinteger

Total number of participants in the campaign.

Changes

No recorded changes to this operation across all 1 revision of this API.