Skip to main content
GET
/
v1
/
analytics
/
vault
Get vault analytics
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/vault \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "aggregation": "daily",
    "total_sessions": 1,
    "total_pageviews": 1,
    "unique_visitors": 1,
    "avg_session_duration": 1,
    "bounce_rate": 50,
    "applied_filters": {}
  },
  "summary": {
    "top_collections": [
      {
        "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "collection_name": "<string>",
        "collection_type": "<string>",
        "collection_media_url": "<string>",
        "pageviews": 1,
        "unique_pageviews": 1,
        "unique_visitors": 1
      }
    ],
    "top_pages": [
      {
        "page_path": "<string>",
        "pageviews": 1,
        "unique_pageviews": 1
      }
    ],
    "top_referrers": [
      {
        "referrer": "<string>",
        "sessions": 1
      }
    ],
    "device_breakdown": {
      "mobile": 1,
      "tablet": 1,
      "desktop": 1
    },
    "browser_breakdown": [
      {
        "browser": "<string>",
        "sessions": 1
      }
    ],
    "os_breakdown": [
      {
        "os": "<string>",
        "sessions": 1
      }
    ],
    "geo_breakdown": [
      {
        "country": "<string>",
        "region": "<string>",
        "sessions": 1
      }
    ]
  },
  "data": [
    {
      "date": "2023-12-25",
      "sessions": 1,
      "pageviews": 1,
      "unique_visitors": 1,
      "avg_session_duration": 1,
      "bounce_rate": 50,
      "top_page": {
        "page_path": "<string>",
        "pageviews": 1
      },
      "device_breakdown": {
        "mobile": 1,
        "tablet": 1,
        "desktop": 1
      }
    }
  ],
  "pagination": {
    "limit": 2,
    "offset": 1,
    "prev": "<string>",
    "next": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

​
start_date
string<date>

The start date for the analytics in ISO 8601 format (e.g., "2024-09-01"). If not provided, defaults to a date based on the aggregation level.

​
end_date
string<date>

The end date for the analytics in ISO 8601 format (e.g., "2024-09-30"). If not provided, defaults to current date.

​
aggregation
enum<string>
default:daily

The aggregation level for the data.

Available options:
daily,
weekly,
monthly,
quarterly,
yearly
​
team_id
string<uuid>

The team ID to filter by. Either team_id or team_slug must be provided.

​
team_slug
string

The team slug to filter by. Either team_id or team_slug must be provided.

​
collection_id
string<uuid>

The collection ID to filter by.

​
collection_slug
string

The collection slug to filter by.

​
token_id
integer

The token ID to filter by.

Required range: x >= 1
​
page_path
string

The page path to filter by.

​
referrer
string

The referrer to filter by.

​
country
string

The country code to filter by.

​
region
string

The region code to filter by.

​
device_type
enum<string>

The device type to filter by.

Available options:
mobile,
tablet,
desktop,
all
​
browser
string

The browser to filter by.

​
os
string

The operating system to filter by.

​
order_by
enum<string>

The field to order by.

Available options:
date,
sessions,
pageviews,
unique_visitors,
avg_session_duration
​
order
enum<string>

The sort order (ascending or descending).

Available options:
asc,
desc
​
limit
integer
default:50

The number of results per page.

Required range: x >= 1
​
offset
integer
default:0

The offset for pagination.

Required range: x >= 0

Response

Successfully fetched vault analytics.

​
meta
object
required
​
summary
object
required
​
data
object[]
required
​
pagination
object
required