Skip to API content
TalkLabs API Docs v3
Recipes
GET Polls

Get Standings

This returns a list of all distinct choices selected by poll respondants, with the count of how many responses each choice had, sorted by choice in ascending order by rank.

GET /api/v3/{appid}/poll/poll/{pollid}/standings

This method requires authentication.

This returns a list of all distinct choices selected by poll respondants, with the count of how many responses each choice had, sorted by choice in ascending order by rank. Rank is computed by sorting by count of choices.

RESPONSE CODES

  • 200 | OK : Sweet, sweet success.

  • 400 | BadRequest : Something is wrong with your request. View response message and errors list for details.

  • 403 | Forbidden : The user doesn't have permission

  • 405 | MethodBlocked : The method was blocked because it contained profanity and filtermode was set to 'block'.

  • 412 | PreconditionFailed : Conditions must be met for standings to be available (depends on the settings of the poll, such as requesting standings while poll is open but poll is configured to only reveal standings when poll is closed)

Request

Parameters

Values in the path and query string.

appid path
string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id
pollid path
string TalkLabs ID required

The TalkLabs assigned poll ID.

Example: poll-id
Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult
400 Bad Request ApiResult
403 Forbidden ApiResult
500 Internal Server Error ApiResult
Example response · 200
{
  "message": "Success",
  "errors": {},
  "data": [
    {
      "kind": "poll.poll",
      "id": "662da20fe45ad80a7f2bd950",
      "appid": "662bb49bf10e9a26a7e8ed92",
      "ownerid": "u-8842",
      "title": "Sample Poll 1: Vote for your favorite color",
      "description": "Vote for your favorite color",
      "posterurl": "",
      "embedcontenttop": "",
      "embedcontentbotton": "",
      "whenpollpublish": "2024-04-28T01:10:39.535Z",
      "whenpollopens": "2024-04-28T01:10:39.535Z",
      "whenpollcloses": null,
      "whenpollexpires": null,
      "displayresults": 1,
      "sortanswers": 0,
      "customtype": "",
      "customid": "sample-poll-1-vote",
      "custompayload": "",
      "customtags": [],
      "customfield1": "",
      "customfield2": ""
    }
  ]
}
Search all 118 endpoints Try “join room”, “moderate”, or “POST”.
Request environment

Connect your application

These values fill request examples and the API console. They stay in this browser tab and are never sent to TalkLabs until you run a request.

Credentials are stored in sessionStorage, not in cookies or analytics.