Get summary KPIs - One of None Documentation

GET

analytics

summary

kpis

Get summary KPIs

curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/summary/kpis \
  --header 'x-api-key: <api-key>'

{
  "overview": {
    "pageviews": 123,
    "sessions": 123,
    "unique_visitors": 123,
    "avg_session_duration": 123,
    "bounce_rate": 123,
    "total_taps": 123,
    "total_registrations": 123,
    "tap_conversion_rate": 123
  },
  "timeseries": [
    {
      "date": "<string>",
      "pageviews": 123,
      "sessions": 123,
      "unique_visitors": 123,
      "avg_session_duration": 123,
      "bounce_rate": 123,
      "total_taps": 123,
      "total_registrations": 123,
      "tap_conversion_rate": 123
    }
  ]
}

Authorizations

x-api-key

string

header

required

Query Parameters

team_id

string

team_slug

string

team_ids

team_slugs

collection_id

string

collection_slug

string

collection_ids

date_from

string

date_to

string

aggregation

enum<string>

Available options:

daily,

weekly,

monthly,

quarterly,

yearly

Response

200 - application/json

Successful response

overview

object

required

Show child attributes

timeseries

object[]

required

Show child attributes

Get vault analytics

Get summary KPIs

curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/summary/kpis \
  --header 'x-api-key: <api-key>'

{
  "overview": {
    "pageviews": 123,
    "sessions": 123,
    "unique_visitors": 123,
    "avg_session_duration": 123,
    "bounce_rate": 123,
    "total_taps": 123,
    "total_registrations": 123,
    "tap_conversion_rate": 123
  },
  "timeseries": [
    {
      "date": "<string>",
      "pageviews": 123,
      "sessions": 123,
      "unique_visitors": 123,
      "avg_session_duration": 123,
      "bounce_rate": 123,
      "total_taps": 123,
      "total_registrations": 123,
      "tap_conversion_rate": 123
    }
  ]
}