OCoctaneai
analytics

Quiz completion funnel

get/v1/quizzes/{quiz_id}/analytics/funnel

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Path parameters

quiz_idstring required

Query parameters

fromstring date nullable

First day, inclusive, in tz; 29 days before to when absent

tostring date nullable

Last day, inclusive, in tz; today when absent

tzstring
channelstring nullable
devicestring nullable
new_returningstring nullable
countrystring nullable

Headers

if-none-matchstring nullable

Response

Analytics for the range. ETag identifies the cached response.

quiz_idstring required
viewsinteger required

Sessions that opened the quiz inside the range, plus the cohort itself.

not_startedinteger required

views minus starts: sessions that viewed the quiz but had neither answered nor stepped forward by the end of the range.

startsinteger required

The cohort: sessions whose first interaction with the quiz (the first answer or the first step forward, whichever comes first) fell inside the range, each followed to its end. starts == completions + sum(sessions_dropped) + in_progress, where pages are served.

completionsinteger required

Cohort sessions that finished the quiz, even past the range end.

in_progressinteger required

Cohort sessions that have neither completed nor ended yet.

Example response

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
}

Changes

No recorded changes to this operation across all 1 revision of this API.