customer-engagement
vocalize
campaign

Get campaign leaderboard

Get leaderboard for a campaign, sorted by score. Additional query parameters can be used to filter and paginate the results. Filter by fromTime and toTime to get scores within a specific time range. Filter by day to get scores for a specific day of the campaign. You cannot use both fromTime/toTime and day together. If no filters are provided, the leaderboard will show all scores for the campaign, paginated. Users who have not provided their name will not be included in the leaderboard.

get/vocalize/2/campaigns/{campaignId}/leaderboard

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

Path parameters

campaignIdstring uuid required

The UUID of the campaign to retrieve the leaderboard for.

Query parameters

pageinteger

Page number.

sizeinteger

Number of records per page.

fromTimestring date-time

Start time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-01T00:00:00Z.

toTimestring date-time

End time for filtering scores (datetime, ISO string, or Unix timestamp). Example value: 2023-10-31T23:59:59Z.

dayinteger

Retrieves scores for a specific day. Can't be used with fromTime/toTime. Days count starts at 0, which means that the API will return scores for the first day of the campaign.

Response

Leaderboard retrieved successfully

Changes

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