analytics

Quiz traffic sources

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

Request

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

Path parameters

quiz_idstring required

Query parameters

by'referrer_host' | 'utm_source' | 'utm_medium' | 'utm_campaign' required
limitinteger
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 nullable required

The quiz; null for every quiz of the store

by'referrer_host' | 'utm_source' | 'utm_medium' | 'utm_campaign' required

What the rows are grouped by

Example response

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
}

Changes

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