Skip to content
POLST Developer Docs

Aggregate completion funnel + drop-off + time series for a campaign.

GET
/brands/me/campaigns/{campaignId}/analytics

Requires the analytics scope. The funnel is computed from VoteEvent rows on each polst in the campaign (no dedicated progress table). entered at position N = respondents who voted on every step 1..N-1 AND are present in the vote set for step N. totalStarts is the set of respondents who voted on position 1. The time series is bucketed by granularity between optional from and to (inclusive).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
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)$/

Campaign UUID.

Query Parameters

Section titled “Query Parameters ”
from
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

ISO-8601 lower bound (inclusive).

to
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

ISO-8601 upper bound (inclusive).

granularity
string
Allowed values: hour day week

Time-series bucket granularity.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Analytics payload.

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
totalStarts
required
integer
<= 9007199254740991
totalCompletions
required
integer
<= 9007199254740991
funnel
required
Array<object>
object
position
required
integer
<= 9007199254740991
slug
required
string
>= 1 characters
entered
required
integer
<= 9007199254740991
voted
required
integer
<= 9007199254740991
dropoffFromStart
required
integer
<= 9007199254740991
dropoff
required
Array<object>
object
fromPosition
required
integer
<= 9007199254740991
toPosition
required
integer
<= 9007199254740991
lost
required
integer
<= 9007199254740991
timeSeries
required
Array<object>
object
bucket
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
starts
required
integer
<= 9007199254740991
completions
required
integer
<= 9007199254740991
votes
required
integer
<= 9007199254740991
granularity
required
string
Allowed values: hour day week
from
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
to
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

401

Section titled “401 ”

Missing or invalid bearer token.

403

Section titled “403 ”

Bearer token lacks analytics scope or has no brand context.

404

Section titled “404 ”

Campaign not found or not owned by the caller.

422

Section titled “422 ”

Query params failed validation.