Skip to content
POLST Developer Docs

Fetch aggregated per-polst tallies for every polst in the campaign.

GET
/campaigns/{campaignId}/results

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
campaignId
required

Campaign UUID.

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Campaign UUID.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Per-polst tallies.

object
data
required
object
campaignId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
totalSteps
required
integer
<= 9007199254740991
polsts
required
Array<object>
object
slug
required
string
>= 1 characters
position
required
integer
<= 9007199254740991
tallies
required
object
optionA
required
integer
<= 9007199254740991
optionB
required
integer
<= 9007199254740991
total
required
integer
<= 9007199254740991

404

Section titled “404 ”

Campaign not found or not publicly visible.

422

Section titled “422 ”

CampaignId is not a UUID.