Skip to main content
GET
/
v1
/
analytics
/
taps
/
conversion
Get taps conversion analytics
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/taps/conversion \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "total_taps": 1,
    "total_registrations": 1,
    "conversion_rate": 123
  },
  "timeseries": [
    {
      "date": "<string>",
      "total_taps": 123,
      "unique_tap_users": 123,
      "total_registrations": 123,
      "unique_reg_users": 123,
      "avg_registration_time": 123,
      "conversion_rate": 123
    }
  ],
  "top_products": [
    {
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "short_url_id": "<string>",
      "total_taps": 1,
      "unique_tap_users": 1,
      "total_registrations": 1,
      "unique_reg_users": 1,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "type": "<string>",
        "image_url": "<string>"
      },
      "short_url": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "url": "<string>",
        "title": "<string>"
      }
    }
  ],
  "top_collections": [
    {
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_taps": 1,
      "unique_tap_users": 1,
      "total_registrations": 1,
      "unique_reg_users": 1,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "type": "<string>",
        "image_url": "<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

​
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
​
token_id
string

Filter by token ID.

​
short_url_id
string

Filter by short URL ID.

​
country_code
string

Filter by country code.

​
region_code
string

Filter by region code.

​
device
enum<string>

Filter by device type.

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

Filter by browser.

​
os
string

Filter by operating system.

​
order
enum<string>

Sort order.

Available options:
asc,
desc
​
order_by
string

Field to sort by.

​
limit
integer

Number of results per page.

Required range: 1 <= x <= 1000
​
offset
integer

Offset for pagination.

Required range: x >= 0

Response

Successfully retrieved taps conversion analytics.

Structured taps/conversion response (BFF pattern).

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