OCoctaneai
analytics

Quiz page-to-page journeys

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

Request

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

Path parameters

quiz_idstring required

Query parameters

cohort'all' | 'finished' | 'left'
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
cohort'all' | 'finished' | 'left' required

Which visits are counted: all | finished (completed the quiz) | left (ended without completing)

sessionsinteger required

Visits counted in this view: the cohort's visits that opened at least one page in the range

data_startstring date nullable required

The first day the store has analytics numbers: its first recorded visit or order, or the day analytics was last reset; null before any

Example response

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
}

Changes

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