Skip to main content
GET
/
v1
/
analytics
/
taps
Get taps analytics
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/taps \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "total_taps": 123
  },
  "timeseries": [
    {
      "date": "<string>",
      "total_taps": 123,
      "unique_users": 123
    }
  ],
  "top_collections": [
    {
      "collection_id": "<string>",
      "total_taps": 123,
      "unique_users": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      }
    }
  ],
  "top_locations": [
    {
      "country_code": "<string>",
      "region_code": "<string>",
      "total_taps": 123,
      "unique_users": 123
    }
  ],
  "top_products": [
    {
      "collection_id": "<string>",
      "short_url_id": "<string>",
      "total_taps": 123,
      "unique_users": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      },
      "short_url": {
        "id": 123,
        "url": "<string>",
        "title": "<string>",
        "token_id": 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
limit
integer
Required range: 1 <= x <= 1000
offset
integer | null
country_code
string
region_code
string
device
enum<string>
Available options:
mobile,
tablet,
desktop,
all
browser
string
os
string
aggregation
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
yearly
order
enum<string>
Available options:
asc,
desc
order_by
string
token_id
string
short_url_id
string

Response

200 - application/json

Successful response

meta
object
required
timeseries
object[]
required
top_collections
object[]
required
top_locations
object[]
required
top_products
object[]
required