Get taps conversion - One of None Documentation

GET

analytics

taps

conversion

Get taps conversion

curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/taps/conversion \
  --header 'x-api-key: <api-key>'

{
  "meta": {
    "total_taps": 123,
    "total_registrations": 123,
    "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": "<string>",
      "short_url_id": "<string>",
      "total_taps": 123,
      "unique_tap_users": 123,
      "total_registrations": 123,
      "unique_reg_users": 123,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      },
      "short_url": {
        "id": 123,
        "url": "<string>",
        "title": "<string>",
        "token_id": 123
      }
    }
  ],
  "top_collections": [
    {
      "collection_id": "<string>",
      "total_taps": 123,
      "unique_tap_users": 123,
      "total_registrations": 123,
      "unique_reg_users": 123,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      }
    }
  ]
}

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

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

Show child attributes

timeseries

object[]

required

Show child attributes

top_products

object[]

required

Show child attributes

top_collections

object[]

required

Show child attributes

Get taps breakdown

Get taps conversion

curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/taps/conversion \
  --header 'x-api-key: <api-key>'

{
  "meta": {
    "total_taps": 123,
    "total_registrations": 123,
    "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": "<string>",
      "short_url_id": "<string>",
      "total_taps": 123,
      "unique_tap_users": 123,
      "total_registrations": 123,
      "unique_reg_users": 123,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      },
      "short_url": {
        "id": 123,
        "url": "<string>",
        "title": "<string>",
        "token_id": 123
      }
    }
  ],
  "top_collections": [
    {
      "collection_id": "<string>",
      "total_taps": 123,
      "unique_tap_users": 123,
      "total_registrations": 123,
      "unique_reg_users": 123,
      "avg_registration_time": 123,
      "conversion_rate": 123,
      "collection": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "image": {
          "url": "<string>"
        }
      }
    }
  ]
}