Skip to main content
GET
Read the results

Authorizations

Authorization
string
header
required

An API key from Settings › API, sent as Authorization: Bearer ptr_…. Shown once when made; only a hash is stored.

Path Parameters

code
string
required

The room's six-digit code

Pattern: ^\d{6}$

Response

OK

code
string
required
title
string
required
status
enum<string>
required
Available options:
lobby,
presenting,
ended
joined
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
pollCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
avgResponseRate
number | null
required

0 to 1, answers over people joined, averaged over the polls

liveMinutes
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
endedMinutesAgo
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
polls
object[]
required

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
string
required

The same results as a markdown summary, ready to paste