{
"id": "support.supper.poll.getVotes",
"defs": {
"main": {
"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": {
"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."
}
},
"$type": "com.atproto.lexicon.schema",
"lexicon": 1
}