> ## Documentation Index
> Fetch the complete documentation index at: https://dev.polltheroom.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the results

> Every poll's results so far, as JSON and as a markdown summary. Works while the room is live and after it ended, for as long as the room is held in memory.

Needs the `results:read` scope.



## OpenAPI

````yaml https://test.polltheroom.com/openapi.json get /api/v1/rooms/{code}/results
openapi: 3.1.0
info:
  title: Poll the Room API
  version: '1'
  description: >-
    Live polls on a presenter's own slides. A presenter (or an agent acting for
    one) builds a deck; the audience joins on their phones with a six-digit code
    and never signs up.


    Keys are made under Settings › API and sent as `Authorization: Bearer
    ptr_…`. A key belongs to a team, carries scopes, and is rate limited per
    hour. Plans: Free may decks:read, decks:write, rooms:read, results:read at
    60 requests an hour; Pro may decks:read, decks:write, rooms:read,
    rooms:start, results:read at 1000 requests an hour.


    The same verbs are MCP tools at https://test.polltheroom.com/api/mcp. The
    full reference is at https://test.polltheroom.com/llms-full.txt.
servers:
  - url: https://test.polltheroom.com
security:
  - apiKey: []
tags:
  - name: decks
    description: A deck is a document the editor and the API both read and write.
  - name: rooms
    description: A room is one live session of a deck.
paths:
  /api/v1/rooms/{code}/results:
    get:
      tags:
        - rooms
      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, for as long as the room is
        held in memory.


        Needs the `results:read` scope.
      operationId: room_results
      parameters:
        - name: code
          in: path
          required: true
          schema:
            type: string
            pattern: ^\d{6}$
            description: The room's six-digit code
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  title:
                    type: string
                  status:
                    type: string
                    enum:
                      - lobby
                      - presenting
                      - ended
                  joined:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  pollCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  avgResponseRate:
                    anyOf:
                      - type: number
                      - type: 'null'
                    description: >-
                      0 to 1, answers over people joined, averaged over the
                      polls
                  liveMinutes:
                    anyOf:
                      - type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      - type: 'null'
                  endedMinutesAgo:
                    anyOf:
                      - type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      - type: 'null'
                  polls:
                    type: array
                    items:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties: {}
                    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
                  markdown:
                    type: string
                    description: The same results as a markdown summary, ready to paste
                required:
                  - code
                  - title
                  - status
                  - joined
                  - pollCount
                  - avgResponseRate
                  - liveMinutes
                  - endedMinutesAgo
                  - polls
                  - markdown
                additionalProperties: false
        '401':
          description: No usable key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope, or the plan does not sell it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Nothing by that id within this key's reach.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's hourly limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: What went wrong, in a sentence
        fix:
          description: What to do about it, when we can tell
          type: string
      required:
        - error
      additionalProperties: false
  securitySchemes:
    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.

````