Read the results
curl --request GET \
--url https://test.polltheroom.com/api/v1/rooms/{code}/results \
--header 'Authorization: Bearer <token>'import requests
url = "https://test.polltheroom.com/api/v1/rooms/{code}/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://test.polltheroom.com/api/v1/rooms/{code}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test.polltheroom.com/api/v1/rooms/{code}/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://test.polltheroom.com/api/v1/rooms/{code}/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://test.polltheroom.com/api/v1/rooms/{code}/results")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.polltheroom.com/api/v1/rooms/{code}/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": "<string>",
"title": "<string>",
"status": "lobby",
"joined": 0,
"pollCount": 0,
"avgResponseRate": 123,
"liveMinutes": 0,
"endedMinutesAgo": 0,
"polls": [
{}
],
"markdown": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}rooms
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.
GET
/
api
/
v1
/
rooms
/
{code}
/
results
Read the results
curl --request GET \
--url https://test.polltheroom.com/api/v1/rooms/{code}/results \
--header 'Authorization: Bearer <token>'import requests
url = "https://test.polltheroom.com/api/v1/rooms/{code}/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://test.polltheroom.com/api/v1/rooms/{code}/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://test.polltheroom.com/api/v1/rooms/{code}/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://test.polltheroom.com/api/v1/rooms/{code}/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://test.polltheroom.com/api/v1/rooms/{code}/results")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://test.polltheroom.com/api/v1/rooms/{code}/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"code": "<string>",
"title": "<string>",
"status": "lobby",
"joined": 0,
"pollCount": 0,
"avgResponseRate": 123,
"liveMinutes": 0,
"endedMinutesAgo": 0,
"polls": [
{}
],
"markdown": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}{
"error": "<string>",
"fix": "<string>"
}Authorizations
An API key from Settings › API, sent as Authorization: Bearer ptr_…. Shown once when made; only a hash is stored.
Path Parameters
The room's six-digit code
Pattern:
^\d{6}$Response
OK
Available options:
lobby, presenting, ended Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 90071992547409910 to 1, answers over people joined, averaged over the polls
Required range:
-9007199254740991 <= x <= 9007199254740991Required range:
-9007199254740991 <= x <= 9007199254740991One snapshot per poll, in deck order: type, prompt, status, options, counts by option id, words, texts, average, distribution, qa, radar, winner, pins, totalAnswers
Show child attributes
Show child attributes
The same results as a markdown summary, ready to paste