polls

View and vote on polls attached to statuses. To discover poll ID, you will need to GET a Status first and then check for a `poll` property.

get
View a poll

https://CounterSocial.example/api/v1/polls/:id

Returns: Poll
OAuth: Public if parent status is public. User token + read:statuses if parent status is private.
Version history:
2.8.0 - added

Request

Path Parameters
:id
required
string
ID of the poll in the database

Response

200: Success

{
  "id": "34830",
  "expires_at": "2019-12-05T04:05:08.302Z",
  "expired": true,
  "multiple": false,
  "votes_count": 10,
  "voters_count": null,
  "voted": true,
  "own_votes": [
    1
  ],
  "options": [
    {
      "title": "accept",
      "votes_count": 6
    },
    {
      "title": "deny",
      "votes_count": 4
    }
  ],
  "emojis": []
}

404: Not Found

Poll does not exist, or poll's parent status is private

{
  "error": "Record not found"
}

post
Vote on a poll

https://CounterSocial.example/api/v1/polls/:id/votes

Returns: Poll
OAuth: User token + write:statuses
Version history:
2.8.0 - added

Request

Path Parameters
:id
required
string
ID of the poll in the database
Headers
Authorization
required
string
Bearer
Form Data Parameters
choices[]
required
array
Array of own votes containing index for each option (starting from 0)

Response

200: Success

Poll was voted on

{
  "id": "34873",
  "expires_at": "2019-12-05T11:16:17.426Z",
  "expired": false,
  "multiple": true,
  "votes_count": 5,
  "voters_count": null,
  "voted": true,
  "own_votes": [
    0,
    2,
    4,
    9,
    6
  ],
  "options": [
    {
      "title": "option 0",
      "votes_count": 1
    },
    {
      "title": "option 1",
      "votes_count": 0
    },
    {
      "title": "option 2",
      "votes_count": 1
    },
    {
      "title": "option 3",
      "votes_count": 0
    },
    {
      "title": "option 4",
      "votes_count": 1
    },
    {
      "title": "option 5",
      "votes_count": 0
    },
    {
      "title": "option 6",
      "votes_count": 1
    },
    {
      "title": "option 7",
      "votes_count": 0
    },
    {
      "title": "option 8",
      "votes_count": 0
    },
    {
      "title": "option 9",
      "votes_count": 1
    }
  ],
  "emojis": []
}

401: Unauthorized

Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

404: Not Found

Poll does not exist, or poll's parent status is private

{
  "error": "Record not found"
}

422: Unprocessable Entity

Already voted or poll is expired

already voted

{
  "error": "Validation failed: You have already voted on this poll"
}
expired
{
  "error": "Validation failed: The poll has already ended"
}

Last updated December 27, 2020 ?? Improve this page