support.supper.poll.getVotes

supper.support

Documentation

Read public vote totals for an exact Supper poll URI and CID. No authentication is required. Optional viewer is a public actor DID, not authentication, and adds that actor latest valid vote. Only support.supper.poll.vote records on support.supper.poll.poll are included. Member-only polls and votes are never exposed.

main query

Read public vote totals for an exact Supper poll URI and CID. No authentication is required. Optional viewer is a public actor DID, not authentication, and adds that actor latest valid vote. Only support.supper.poll.vote records on support.supper.poll.poll are included. Member-only polls and votes are never exposed.

Parameters

subject string at-uri Required

Public support.supper.poll.poll AT URI.

subjectCid string cid Required

CID of the exact poll revision whose choices are being tallied.

viewer string did Optional

Optional public actor DID whose currently selected vote is requested.

Output

Encodingapplication/json
counts array Required

One count per poll option in its original order, including zero-vote options. Counts sum to total.

subject stringat-uri Required

Exact public poll URI requested.

subjectCid stringcid Required

Exact public poll revision requested.

total integer Required

Number of distinct actors with a valid surviving vote on this exact revision.

viewerVote ref#viewerVote Optional

Requested actor latest valid surviving vote, omitted if none exists.

Errors

InvalidRequest The subject, revision or viewer is invalid.
NotFound The exact public poll revision is unavailable.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Public support.supper.poll.poll AT URI.
CID of the exact poll revision whose choices are being tallied.
Optional public actor DID whose currently selected vote is requested.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "InvalidRequest",
      "description": "The subject, revision or viewer is invalid."
    },
    {
      "name": "NotFound",
      "description": "The exact public poll revision is unavailable."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "subject",
        "subjectCid",
        "counts",
        "total"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of distinct actors with a valid surviving vote on this exact revision."
        },
        "counts": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0
          },
          "maxLength": 10,
          "minLength": 2,
          "description": "One count per poll option in its original order, including zero-vote options. Counts sum to total."
        },
        "subject": {
          "type": "string",
          "format": "at-uri",
          "description": "Exact public poll URI requested."
        },
        "subjectCid": {
          "type": "string",
          "format": "cid",
          "description": "Exact public poll revision requested."
        },
        "viewerVote": {
          "ref": "#viewerVote",
          "type": "ref",
          "description": "Requested actor latest valid surviving vote, omitted if none exists."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "subject",
      "subjectCid"
    ],
    "properties": {
      "viewer": {
        "type": "string",
        "format": "did",
        "description": "Optional public actor DID whose currently selected vote is requested."
      },
      "subject": {
        "type": "string",
        "format": "at-uri",
        "description": "Public support.supper.poll.poll AT URI."
      },
      "subjectCid": {
        "type": "string",
        "format": "cid",
        "description": "CID of the exact poll revision whose choices are being tallied."
      }
    }
  },
  "description": "Read public vote totals for an exact Supper poll URI and CID. No authentication is required. Optional viewer is a public actor DID, not authentication, and adds that actor latest valid vote. Only support.supper.poll.vote records on support.supper.poll.poll are included. Member-only polls and votes are never exposed."
}
viewerVote object

Public record identity of the requested actor latest valid vote.

Properties

cid string cid Required

CID of that vote record.

option integer Required

Zero-based selected option.

minimum: 0maximum: 9
uri string at-uri Required

AT URI of the actor-owned support.supper.poll.vote record.

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "option"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of that vote record."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the actor-owned support.supper.poll.vote record."
    },
    "option": {
      "type": "integer",
      "maximum": 9,
      "minimum": 0,
      "description": "Zero-based selected option."
    }
  },
  "description": "Public record identity of the requested actor latest valid vote."
}

Lexicon Garden

@