GET
/
v1
/
analytics
/
taps
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/taps \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "aggregation": "daily",
    "total_taps": 1,
    "unique_users": 1,
    "unique_products": 1,
    "average_taps_per_product": 1,
    "applied_filters": {}
  },
  "summary": {
    "top_tapped_collections": [
      {
        "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "collection_name": "<string>",
        "collection_slug": "<string>",
        "image_url": "<string>",
        "taps": 1
      }
    ],
    "top_tapped_products": [
      {
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_name": "<string>",
        "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "taps": 1
      }
    ],
    "top_locations": [
      {
        "country": "<string>",
        "region": "<string>",
        "taps": 1
      }
    ],
    "os_breakdown": {
      "ios": 1,
      "android": 1,
      "other": 1
    },
    "geo_breakdown": [
      {
        "country": "<string>",
        "region": "<string>",
        "total_taps": 1
      }
    ]
  },
  "data": [
    {
      "date": "2023-12-25",
      "total_taps": 1,
      "unique_users": 1,
      "top_product": {
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "taps": 1
      },
      "os_breakdown": {
        "ios": 1,
        "android": 1,
        "other": 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

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

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

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

The collection ID to filter by.

​
collection_slug
string

The collection slug to filter by.

​
product_id
string

The product ID to filter by.

​
short_url_id
string

The short URL ID to filter by.

​
country
string

The country code to filter by.

​
region
string

The region code to filter by.

​
os
enum<string>

The operating system to filter by.

Available options:
ios,
android,
other,
all
​
order_by
enum<string>

The field to order by.

Available options:
date,
total_taps,
unique_users,
conversion_rate
​
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

200
application/json

Successfully fetched product taps analytics.

The response is of type object.