analytics

Compare quiz analytics

get/v1/analytics/quizzes

Request

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

Query parameters

qstring nullable
limitinteger
offsetinteger
sort'name' | 'views' | 'starts' | 'completion_rate' | 'opt_ins' | 'orders' | 'revenue' | 'share'
dir'asc' | 'desc'
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

Headers

if-none-matchstring nullable

Response

Analytics for the range. ETag identifies the cached response.

has_moreboolean required
totalinteger required

How many quizzes match the search, across every page

limitinteger required
offsetinteger required
sort'name' | 'views' | 'starts' | 'completion_rate' | 'opt_ins' | 'orders' | 'revenue' | 'share' required
dir'asc' | 'desc' required

Example response

{
  "data": [
    {
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
    }
  ]
}

Changes

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