Skip to main content
GET
/
v1
/
analytics
/
registrations
Get product registration analytics
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/registrations \
  --header 'x-api-key: <api-key>'
{
  "meta": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "aggregation": "daily",
    "total_registrations": 1,
    "guest_registrations": 1,
    "verified_registrations": 1,
    "average_registration_time": 1,
    "applied_filters": {}
  },
  "summary": {
    "top_collections": [
      {
        "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "collection_name": "<string>",
        "collection_type": "<string>",
        "collection_media_url": "<string>",
        "total_registrations": 1,
        "guest_registrations": 1,
        "verified_registrations": 1
      }
    ],
    "registration_trend": "increasing",
    "verification_rate": 50
  },
  "data": [
    {
      "date": "2023-12-25",
      "total_registrations": 1,
      "guest_registrations": 1,
      "verified_registrations": 1,
      "average_registration_time": 1,
      "top_product": {
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_name": "<string>",
        "product_media_url": "<string>",
        "registrations": 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<date>

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<date>

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
​
registration_type
enum<string>
default:all

The type of registration to filter by.

Available options:
guest,
verified,
all
​
team_id
string<uuid>

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<uuid>

The collection ID to filter by.

​
collection_slug
string

The collection slug to filter by.

​
product_id
string<uuid>

The product ID to filter by.

​
country
string

The country code to filter by.

​
region
string

The region code to filter by.

​
min_value
number

The minimum product value to filter by.

Required range: x >= 0
​
max_value
number

The maximum product value to filter by.

Required range: x >= 0
​
order_by
enum<string>
default:date

The field to order by.

Available options:
date,
total_registrations,
guest_registrations,
verified_registrations,
avg_registration_time
​
order
enum<string>
default:desc

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

Successfully fetched product registration analytics.

​
meta
object
required
​
summary
object
required
​
data
object[]
required
​
pagination
object
required