GET
/
statistics
Retrieve statistics
curl --request GET \
  --url https://api.supaqr.com/statistics \
  --header 'Authorization: Bearer <token>'
{
  "clicks": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
groupBy
enum<string>
default:count

The parameter to group the statistics data points by.

Available options:
count,
time,
link,
link_type,
destination,
country,
region,
city,
os,
browser,
device,
referer,
referer_url,
utm_source,
utm_medium,
utm_campaign,
utm_term,
utm_content
​
timezone
string

This field becomes required when groupBy = 'time'.

​
startTime
string<date-time>

The start date and time (ISO 8601 UTC timestamp) when to retrieve statistics from.Takes precedence over interval.

​
endTime
string<date-time>

The end date and time (ISO 8601 UTC timestamp) when to retrieve statistics from. If not provided, defaults to the current date. Takes precedence over interval.

​
interval
enum<string>
default:24h

The interval to retrieve statistics for.

Available options:
24h,
7d,
30d,
90d,
180d,
1y,
all
​
domain
string

The domain to retrieve statistics for.

Maximum length: 200
​
link
string

The url to retrieve statistics for.Takes precedence over domain.

​
linkType
enum<string>

The linkType to retrieve statistics for.

Available options:
link,
document,
file,
vcard,
landing-page,
google-form,
menu,
app-stores,
image,
audio,
video,
wi-fi,
email,
map,
whatsapp,
text,
sms,
svg,
code
​
tagNames
string[]

The tag Names to retrieve statistics for.

​
tagIds
string[]

The tag IDs to retrieve statistics for.Takes precedence over tagNames.

Required array length: 1 - 50 elements
​
continent
enum<string>

The continent to retrieve statistics for.

Available options:
Africa,
Asia,
Europe,
North America,
South America,
Oceania
​
country
string

The country to retrieve statistics for.

​
city
string

The city to retrieve statistics for.

​
region
string

The region to retrieve statistics for.

​
device
enum<string>

The device to retrieve statistics for.

Available options:
Desktop,
Mobile,
Tablet,
Embedded,
SmartTv,
Wearable,
XR,
Others
​
browser
enum<string>

The browser to retrieve statistics for.

Available options:
Chrome,
Edge,
Safari,
Firefox,
Opera,
Samsung Internet,
Android Browser,
Others
​
os
enum<string>

The OS to retrieve statistics for.

Available options:
IOS,
Android,
Windows,
MacOS,
Linux,
HarmonyOS,
Other
​
referer
string

The referer to retrieve statistics for.

​
refererUrl
string

The full referer URL to retrieve statistics for.

​
destination
string

The destination to retrieve statistics for.

Maximum length: 200
​
utm_source
string

The UTM source of the link(QR code).

Maximum length: 190
​
utm_medium
string

The UTM medium of the link(QR code).

Maximum length: 190
​
utm_campaign
string

The UTM campaign of the link(QR code).

Maximum length: 190
​
utm_term
string

The UTM term of the link(QR code).

Maximum length: 190
​
utm_content
string

The UTM content of the link(QR code).

Maximum length: 190

Response

200
application/json

The response is of type object.