GET
/
events

Events endpoints require a Business plan subscription or higher.

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Query Parameters

event
enum<string>
default: clicks

The type of event to retrieve analytics for. Defaults to 'clicks'.

Available options:
clicks,
leads,
sales
domain
string

The domain to filter analytics for.

key
string

The short link slug.

linkId
string

The unique ID of the short link on Dub.

externalId
string

This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.

interval
enum<string>
default: 24h

The interval to retrieve events for. Takes precedence over start and end. If undefined, defaults to 24h.

Available options:
24h,
7d,
30d,
90d,
ytd,
1y,
all
start
string

The start date and time when to retrieve analytics from. Takes precedence over interval.

end
string

The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over interval.

timezone
string
default: UTC

The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.

continent
enum<string>

The continent to retrieve analytics for.

Available options:
AF,
AN,
AS,
EU,
NA,
OC,
SA
country
enum<string>

The country to retrieve analytics for.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MK,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW,
AX,
BQ,
CW,
GG,
IM,
JE,
ME,
BL,
MF,
RS,
SX,
SS,
XK
city
string

The city to retrieve analytics for.

device
string

The device to retrieve analytics for.

browser
string

The browser to retrieve analytics for.

os
string

The OS to retrieve analytics for.

trigger
enum<string>

The trigger to retrieve analytics for. If undefined, return both QR and link clicks.

Available options:
qr,
link
referer
string

The referer to retrieve analytics for.

refererUrl
string

The full referer URL to retrieve analytics for.

url
string

The URL to retrieve analytics for.

tagId
string
deprecated

Deprecated. Use tagIds instead. The tag ID to retrieve analytics for.

tagIds

The tag IDs to retrieve analytics for.

qr
boolean
deprecated

Deprecated. Use the trigger field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.

root
boolean

Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.

page
number
default: 1
limit
number
default: 100
order
enum<string>
default: desc
Available options:
asc,
desc
sortBy
enum<string>
default: timestamp
Available options:
timestamp

Response

200 - application/json
event
enum<string>
required
Available options:
click
timestamp
string
click
object
required
link
object
required
click_id
string
requireddeprecated

Deprecated. Use click.id instead.

link_id
string
requireddeprecated

Deprecated. Use link.id instead.

domain
string
requireddeprecated

Deprecated. Use link.domain instead.

key
string
requireddeprecated

Deprecated. Use link.key instead.

url
string
requireddeprecated

Deprecated. Use click.url instead.

continent
string
requireddeprecated

Deprecated. Use click.continent instead.

country
string
requireddeprecated

Deprecated. Use click.country instead.

city
string
requireddeprecated

Deprecated. Use click.city instead.

device
string
requireddeprecated

Deprecated. Use click.device instead.

browser
string
requireddeprecated

Deprecated. Use click.browser instead.

os
string
requireddeprecated

Deprecated. Use click.os instead.

qr
number
requireddeprecated

Deprecated. Use click.qr instead.

ip
string
requireddeprecated

Deprecated. Use click.ip instead.

Was this page helpful?

Retrieve analyticsCreate a new tag