Skip to main content
GET
/
v1
/
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": 1,
    "sessions": 1,
    "unique_visitors": 1,
    "total_taps": 1,
    "total_registrations": 1,
    "tap_conversion_rate": 123,
    "avg_session_duration": 123,
    "bounce_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

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

Query Parameters

​
collection_id
string<uuid>

Filter by collection ID.

​
collection_slug
string

Filter by collection slug.

​
date_from
string<date>

Start date in ISO 8601 format.

​
date_to
string<date>

End date in ISO 8601 format.

​
aggregation
enum<string>

Time interval for aggregation.

Available options:
daily,
weekly,
monthly,
quarterly,
yearly

Response

Successfully retrieved summary KPIs.

Structured summary/kpis response (BFF pattern).

​
overview
object
required
​
timeseries
object[]
required