Every poll’s results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Poll the Room","description":"Live polls on a presenter's own slides. Build decks, put polls on slides, run rooms and read results, from code or from an AI agent.","colors":{"primary":"#3333ff","light":"#8f8fff","dark":"#3333ff"},"logo":{"light":"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/light.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=9ba2b3ce482ba5c06a0fa3c750a47acd","dark":"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/dark.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=08ce6c0b4945f87688866fe6a49adbc6","href":"https://test.polltheroom.com"},"favicon":"https://mintcdn.com/polltheroom/Beb7336SfQDVOA4K/favicon.svg?fit=max\u0026auto=format\u0026n=Beb7336SfQDVOA4K\u0026q=85\u0026s=b62f27bdae4382c39a777ea188ce3b68","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://test.polltheroom.com","label":"Open Poll the Room"}],"primary":{"type":"button","label":"Get an API key","href":"https://test.polltheroom.com/settings/api"}},"footer":{"socials":{"website":"https://test.polltheroom.com"}},"seo":{"metatags":{"robots":"noindex"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polltheroom","hasAudioNarration":false,"actualSubdomain":"polltheroom","customDomains":["dev.polltheroom.com"],"gitSource":{"type":"github","owner":"internetoftoday","repo":"polltheroom","deployBranch":"docs","contentDirectory":"developers","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ad4a9629d4e735aef35504f","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":27},{"language":"default","tag":"decks","count":21},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"rooms","count":5},{"language":"default","tag":"Concepts","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Reference","count":2},{"language":"default","tag":"MCP","count":2},{"language":"default","tag":"MCP server","count":2},{"language":"default","tag":"Start here","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/rooms/read-the-results","slug":"/api-reference/rooms/read-the-results","pageMetadata":{"title":"Read the results","description":"Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead.\n\nNeeds the `results:read` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms/{code}/results","href":"/api-reference/rooms/read-the-results","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Every poll’s results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Needs the \", _jsx(_components.code, {\n children: \"results:read\"\n }), \" scope.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read the results","description":"Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead.\n\nNeeds the `results:read` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms/{code}/results","href":"/api-reference/rooms/read-the-results","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"room_results","summary":"Read the results","description":"Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead.\n\nNeeds the `results:read` scope.","x-scope":"results:read","tags":["rooms"],"parameters":["57688404-d589-4895-9ace-fdac1301b676"],"responses":{"200":"ec0fae20-5f6e-4e6f-8ef7-e2f1a627d263","401":"58af6746-4c22-4f86-8652-2a3a68d2d43a","403":"4a69ebc4-a22c-49c4-9e33-2ac7225c50a4","404":"0fd1443a-8951-4c93-b65c-e73ddc177152","429":"b50806aa-f9b7-4592-af45-f3ad044bc882"},"method":"get","type":"path","servers":["5817ffd4-0b64-4c93-a98d-913208924ee1"],"security":["7162788f-04d2-4ba0-9f6c-593e2d5b4e6f"],"path":"/api/v1/rooms/{code}/results","baseUrlOptions":["https://test.polltheroom.com"],"title":"Read the results","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"57688404-d589-4895-9ace-fdac1301b676":{"name":"code","in":"path","required":true,"schema":{"type":"string","pattern":"^\\d{6}$","description":"The room's six-digit code","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"487308"}},"responses":{"ec0fae20-5f6e-4e6f-8ef7-e2f1a627d263":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"string","enum":["lobby","presenting","ended"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"joined":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"joined","typeLabel":"integer"},"pollCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"pollCount","typeLabel":"integer"},"avgResponseRate":{"oneOf":[{"type":"number","description":"0 to 1, answers over people joined, averaged over the polls","isRequired":true,"uniqueKey":"avgResponseRate.oneOf.0","typeLabel":"number"},{"type":"null","description":"0 to 1, answers over people joined, averaged over the polls","isRequired":true,"uniqueKey":"avgResponseRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"avgResponseRate","typeLabel":"number | null"},"liveMinutes":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"liveMinutes.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"liveMinutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"liveMinutes","typeLabel":"integer | null"},"endedMinutesAgo":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"endedMinutesAgo.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"endedMinutesAgo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"endedMinutesAgo","typeLabel":"integer | null"},"polls":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"polls.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"polls.items.[INDEX]","typeLabel":"object"},"description":"One snapshot per poll, in deck order: type, prompt, status, options, counts by option id, words, texts, average, distribution, qa, radar, winner, pins, totalAnswers","isRequired":true,"uniqueKey":"polls","typeLabel":"object[]"},"markdown":{"type":"string","description":"The same results as a markdown summary, ready to paste","isRequired":true,"uniqueKey":"markdown","typeLabel":"string"},"label":{"description":"The session's name, when it was given one","type":"string","uniqueKey":"label","typeLabel":"string"}},"required":["code","title","status","joined","pollCount","avgResponseRate","liveMinutes","endedMinutesAgo","polls","markdown"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"code":"487308","title":"Town hall, September","label":"Amsterdam office, Tuesday","status":"ended","joined":42,"pollCount":3,"avgResponseRate":0.81,"liveMinutes":38,"endedMinutesAgo":4,"polls":[{"id":"e66cae1e-f56d-404f-8357-6595c115d407","type":"rating","status":"final","prompt":"How sure are you about the plan?","options":[],"counts":{},"words":[],"texts":[],"average":4.1,"distribution":{"1":1,"2":2,"3":4,"4":13,"5":14},"reactions":{},"qa":[],"correctOptionId":null,"pins":[],"winner":null,"leaderboard":[],"totalAnswers":34,"endsAt":null,"timeLimitSec":null},{"id":"477b12ea-270f-4bf1-9036-fce88ba55a9a","type":"multiple-choice","status":"final","prompt":"Which bet do we start with?","options":[{"id":"ac5ce243-bcad-4503-9490-1e71ba035fe4","label":"New pricing"},{"id":"676bcde3-ab64-4e9a-ade3-17ab62736afb","label":"Mobile app"},{"id":"81736b3a-fdee-46f5-bdb3-d599e75aaeae","label":"Partner program"}],"counts":{"ac5ce243-bcad-4503-9490-1e71ba035fe4":17,"676bcde3-ab64-4e9a-ade3-17ab62736afb":12,"81736b3a-fdee-46f5-bdb3-d599e75aaeae":7},"words":[],"texts":[],"average":null,"distribution":{},"reactions":{},"qa":[],"correctOptionId":null,"pairs":[],"pins":[],"winner":null,"leaderboard":[],"totalAnswers":36,"endsAt":null,"timeLimitSec":null},{"id":"399d657c-8516-44da-8f3f-73b7d9cab877","type":"word-cloud","status":"final","prompt":"One word to take home?","options":[],"counts":{},"words":[{"text":"focus","count":9},{"text":"clarity","count":6},{"text":"momentum","count":5},{"text":"pricing","count":4}],"texts":[],"average":null,"distribution":{},"reactions":{},"qa":[],"correctOptionId":null,"pins":[],"winner":null,"leaderboard":[],"totalAnswers":32,"endsAt":null,"timeLimitSec":null}],"markdown":"# Town hall, September\n\nRoom 487308. 42 joined. 3 polls. Live for 38 minutes.\n\n## How sure are you about the plan?\n\nStar rating. 34 answered.\n\n- Average 4.1\n- 1: 1\n- 2: 2\n- 3: 4\n- 4: 13\n- 5: 14\n\n## Which bet do we start with?\n\nMultiple choice. 36 answered.\n\n- New pricing: 17 (47%)\n- Mobile app: 12 (33%)\n- Partner program: 7 (19%)\n\n## One word to take home?\n\nWord cloud. 32 answered.\n\n- focus (9)\n- clarity (6)\n- momentum (5)\n- pricing (4)\n"},"examples":{"Example":{"title":"Example","value":{"code":"487308","title":"Town hall, September","label":"Amsterdam office, Tuesday","status":"ended","joined":42,"pollCount":3,"avgResponseRate":0.81,"liveMinutes":38,"endedMinutesAgo":4,"polls":[{"id":"e66cae1e-f56d-404f-8357-6595c115d407","type":"rating","status":"final","prompt":"How sure are you about the plan?","options":[],"counts":{},"words":[],"texts":[],"average":4.1,"distribution":{"1":1,"2":2,"3":4,"4":13,"5":14},"reactions":{},"qa":[],"correctOptionId":null,"pins":[],"winner":null,"leaderboard":[],"totalAnswers":34,"endsAt":null,"timeLimitSec":null},{"id":"477b12ea-270f-4bf1-9036-fce88ba55a9a","type":"multiple-choice","status":"final","prompt":"Which bet do we start with?","options":[{"id":"ac5ce243-bcad-4503-9490-1e71ba035fe4","label":"New pricing"},{"id":"676bcde3-ab64-4e9a-ade3-17ab62736afb","label":"Mobile app"},{"id":"81736b3a-fdee-46f5-bdb3-d599e75aaeae","label":"Partner program"}],"counts":{"ac5ce243-bcad-4503-9490-1e71ba035fe4":17,"676bcde3-ab64-4e9a-ade3-17ab62736afb":12,"81736b3a-fdee-46f5-bdb3-d599e75aaeae":7},"words":[],"texts":[],"average":null,"distribution":{},"reactions":{},"qa":[],"correctOptionId":null,"pairs":[],"pins":[],"winner":null,"leaderboard":[],"totalAnswers":36,"endsAt":null,"timeLimitSec":null},{"id":"399d657c-8516-44da-8f3f-73b7d9cab877","type":"word-cloud","status":"final","prompt":"One word to take home?","options":[],"counts":{},"words":[{"text":"focus","count":9},{"text":"clarity","count":6},{"text":"momentum","count":5},{"text":"pricing","count":4}],"texts":[],"average":null,"distribution":{},"reactions":{},"qa":[],"correctOptionId":null,"pins":[],"winner":null,"leaderboard":[],"totalAnswers":32,"endsAt":null,"timeLimitSec":null}],"markdown":"# Town hall, September\n\nRoom 487308. 42 joined. 3 polls. Live for 38 minutes.\n\n## How sure are you about the plan?\n\nStar rating. 34 answered.\n\n- Average 4.1\n- 1: 1\n- 2: 2\n- 3: 4\n- 4: 13\n- 5: 14\n\n## Which bet do we start with?\n\nMultiple choice. 36 answered.\n\n- New pricing: 17 (47%)\n- Mobile app: 12 (33%)\n- Partner program: 7 (19%)\n\n## One word to take home?\n\nWord cloud. 32 answered.\n\n- focus (9)\n- clarity (6)\n- momentum (5)\n- pricing (4)\n"}}},"exampleType":"examples"}},"exampleType":"examples"},"58af6746-4c22-4f86-8652-2a3a68d2d43a":{"description":"No usable key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4a69ebc4-a22c-49c4-9e33-2ac7225c50a4":{"description":"The key lacks the scope, or the plan does not sell it.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0fd1443a-8951-4c93-b65c-e73ddc177152":{"description":"Nothing by that id within this key's reach.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b50806aa-f9b7-4592-af45-f3ad044bc882":{"description":"Over the key's hourly limit.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"What went wrong, in a sentence","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"fix":{"description":"What to do about it, when we can tell","type":"string","uniqueKey":"fix","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","fix":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7162788f-04d2-4ba0-9f6c-593e2d5b4e6f":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","scopes":[],"schemeName":"apiKey"}}},"servers":{"5817ffd4-0b64-4c93-a98d-913208924ee1":{"url":"https://test.polltheroom.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from Settings › API, sent as `Authorization: Bearer ptr_…`. Shown once when made; only a hash is stored.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"https://test.polltheroom.com/openapi.json"},"subdomain":"polltheroom","siteName":"Poll the Room","title":"Read the results - Poll the Room","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T14:49:05.128Z","originalFileLocation":"api-reference/rooms/read-the-results.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every poll\u0026#x27;s results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead. Needs the results:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Poll the Room\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read the results - Poll the Room\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every poll\u0026#x27;s results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead. Needs the results:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Poll the Room\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.polltheroom.com/api-reference/rooms/read-the-results\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polltheroom.mintlify.site/_mintlify/api/og/v2?division=rooms\u0026amp;title=Read+the+results\u0026amp;description=Every+poll%27s+results+so+far%2C+as+JSON+and+as+a+markdown+summary.+Works+while+the+room+is+live+and+after+it+ended%3B+once+the+app+no+longer+holds+the+room%2C+the+resu\u0026amp;theme=625264d4e40254fb4eb43184\u0026amp;signature=f5ba66afcdc7dfb2bf03c24f13783cdbb70e853b7dec9de60bf2fd542655b765\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Read the results - Poll the Room\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every poll\u0026#x27;s results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead. Needs the results:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polltheroom.mintlify.site/_mintlify/api/og/v2?division=rooms\u0026amp;title=Read+the+results\u0026amp;description=Every+poll%27s+results+so+far%2C+as+JSON+and+as+a+markdown+summary.+Works+while+the+room+is+live+and+after+it+ended%3B+once+the+app+no+longer+holds+the+room%2C+the+resu\u0026amp;theme=625264d4e40254fb4eb43184\u0026amp;signature=f5ba66afcdc7dfb2bf03c24f13783cdbb70e853b7dec9de60bf2fd542655b765\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/polltheroom/7KTc0c_TZbUysiH7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Poll the Room\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3333ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.polltheroom.com/api-reference/rooms/read-the-results\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/rooms/read-the-results.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.polltheroom.com/#organization\",\"name\":\"Poll the Room\",\"url\":\"https://dev.polltheroom.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polltheroom/wm5nU6Sq7YIILBAr/logo/light.svg?fit=max\u0026auto=format\u0026n=wm5nU6Sq7YIILBAr\u0026q=85\u0026s=9ba2b3ce482ba5c06a0fa3c750a47acd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.polltheroom.com#website\",\"name\":\"Poll the Room\",\"url\":\"https://dev.polltheroom.com\",\"publisher\":{\"@id\":\"https://dev.polltheroom.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results#webpage\",\"url\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results\",\"name\":\"Read the results\",\"description\":\"Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead. Needs the results:read scope.\",\"dateModified\":\"2026-10-14T14:49:05.128Z\",\"isPartOf\":{\"@id\":\"https://dev.polltheroom.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"rooms\",\"item\":\"https://dev.polltheroom.com/api-reference/rooms/list-rooms\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read the results\",\"item\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results#apireference\",\"headline\":\"Read the results\",\"name\":\"Read the results\",\"description\":\"Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended; once the app no longer holds the room, the results saved when its last poll closed or it ended come back instead. Needs the results:read scope.\",\"url\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results\",\"mainEntityOfPage\":{\"@id\":\"https://dev.polltheroom.com/api-reference/rooms/read-the-results#webpage\"},\"dateModified\":\"2026-10-14T14:49:05.128Z\",\"publisher\":{\"@id\":\"https://dev.polltheroom.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.polltheroom.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Poll the Room\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Poll the Room","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp-server"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Start here","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"decks","pages":[{"title":"List decks","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks","href":"/api-reference/decks/list-decks"},{"title":"Create a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks","href":"/api-reference/decks/create-a-deck"},{"title":"Get a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}","href":"/api-reference/decks/get-a-deck"},{"title":"Bin a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}","href":"/api-reference/decks/bin-a-deck"},{"title":"Change a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}","href":"/api-reference/decks/change-a-deck"},{"title":"Add a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps","href":"/api-reference/decks/add-a-step"},{"title":"Read one step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/read-one-step"},{"title":"Replace a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json put /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/replace-a-step"},{"title":"Remove a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}","href":"/api-reference/decks/remove-a-step"},{"title":"Put a poll on a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/overlays","href":"/api-reference/decks/put-a-poll-on-a-slide"},{"title":"Outline a deck","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/outline","href":"/api-reference/decks/outline-a-deck"},{"title":"Take a card off a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}/overlays/{card}","href":"/api-reference/decks/take-a-card-off-a-slide"},{"title":"Change a card","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}/steps/{index}/overlays/{card}","href":"/api-reference/decks/change-a-card"},{"title":"Put text, a shape or a picture on a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/elements","href":"/api-reference/decks/put-text-a-shape-or-a-picture-on-a-slide"},{"title":"Take text, a shape or a picture off a slide","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json delete /api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}","href":"/api-reference/decks/take-text-a-shape-or-a-picture-off-a-slide"},{"title":"Change text, a shape or a picture","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json patch /api/v1/decks/{id}/steps/{index}/elements/{kind}/{element}","href":"/api-reference/decks/change-text-a-shape-or-a-picture"},{"title":"Copy a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/duplicate","href":"/api-reference/decks/copy-a-step"},{"title":"Move a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/decks/{id}/steps/{index}/move","href":"/api-reference/decks/move-a-step"},{"title":"Screenshot a step","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/steps/{index}/screenshot","href":"/api-reference/decks/screenshot-a-step"},{"title":"List the fonts","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/fonts","href":"/api-reference/decks/list-the-fonts"},{"title":"Attach the slides as a PDF","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json put /api/v1/decks/{id}/source","href":"/api-reference/decks/attach-the-slides-as-a-pdf"}]},{"group":"rooms","pages":[{"title":"List rooms","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms","href":"/api-reference/rooms/list-rooms"},{"title":"Start a room","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/rooms","href":"/api-reference/rooms/start-a-room"},{"title":"Drive a room","description":"What the presenter's buttons do: start the session, walk to the next or previous step, close the live poll and reveal, or stop the session; spin the wheel on screen, show or hide the join code in the corner of the audience screen (chip), switch live reactions on or off, or put the quiz standings over whatever is on screen and take them away again (standings).\n\nNeeds the `rooms:start` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json post /api/v1/rooms/{code}/actions","href":"/api-reference/rooms/drive-a-room"},{"title":"Read the results","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/rooms/{code}/results","href":"/api-reference/rooms/read-the-results"},{"title":"Read every session's results","description":"Every session one deck has run, oldest first, each with its results as JSON and as a markdown summary, in one call: a deck presented to ten classes answers with ten sessions. Send `answers` for every answer as a row as well, with the name the person joined under, what they answered, whether a quiz answer was right and how many seconds it took, the rows the app's spreadsheet download holds. Send `sessions` to read only some of them.\n\nNeeds the `results:read` scope.","deprecated":null,"version":null,"openapi":"https://test.polltheroom.com/openapi.json get /api/v1/decks/{id}/results","href":"/api-reference/rooms/read-every-sessions-results"}]}]}]},"basePath":"","title":"Read the results - Poll the Room","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}