Poll

Represents a poll attached to a status.

{
  "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": []
}

Poll attributes

`id`

Description: The ID of the poll in the database. Type: String (cast from an integer, but not guaranteed to be a number) Version history: Added in 2.8.0

`expires_at`

Description: When the poll ends. Type: String (ISO 8601 Datetime), or null if the poll does not end Version history: Added in 2.8.0

`expired`

Description: Is the poll currently expired? Type: Boolean Version history: Added in 2.8.0

`multiple`

Description: Does the poll allow multiple-choice answers? Type: Boolean Version history: Added in 2.8.0

`votes_count`

Description: How many votes have been received. Type: Number Version history: Added in 2.8.0

`voters_count`

Description: How many unique accounts have voted on a multiple-choice poll. Type: Number, or null if multiple is false. Version history: Added in 2.8.0

`voted`

Description: When called with a user token, has the authorized user voted? Type: Boolean, or null if no current user Version history: Added in 2.8.0

`own_votes`

Description: When called with a user token, which options has the authorized user chosen? Contains an array of index values for options. Type: Array of Number, or null if no current user Version history: Added in 2.8.0

`options[]`

Description: Possible answers for the poll. Type: Array of Hash Version history: Added in 2.8.0

`options[][title]`

The text value of the poll option. String.

`options[][votes_count]`

The number of received votes for this option. Number, or null if results are not published yet.

`emojis`

Description: Custom emoji to be used for rendering poll options. Type: Array of Emoji Version history: Added in 2.8.0

Poll attributes

id

expires_at

expired

multiple

votes_count

voters_count

voted

own_votes

options[]

options[][title]

options[][votes_count]

emojis

See also