dub.events.list
Retrieve a list of events for the authenticated workspace. The list will be paginated and the provided query parameters allow filtering the returned events.
Events endpoints require a Business plan subscription or higher.
Arguments
The type of event to retrieve events for. Available options: clicks,
leads, and sales.
The domain of the short link.
The short link slug.
The unique ID of the short link on Dub.
This is the ID of the link in the your database. Must be prefixed with ‘ext_’ when passed as a query parameter.
The interval to retrieve events for.
Available options are 1h, 24h, 7d, 30d, 90d, ytd, 1y, and all.
Takes precedence over start and end.
The start date to retrieve events for.
Cannot be earlier than September 22, 2022.
The start date to retrieve events for.
Cannot be in the future. If not provided, defaults to the current date.
The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
The continent to retrieve events for.
Available options are AF, AN, AS, EU, NA, OC, and SA.
The country to retrieve events for.
Available options are 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
The city to retrieve events for.
The ISO 3166-2 region code to retrieve analytics for.
The device to retrieve events for.
The browser to retrieve events for.
The OS to retrieve events for.
The trigger to retrieve analytics for. Available options: qr, link. If
undefined, return both QR and link clicks.
The referer to retrieve events for.
The full referer URL to retrieve events for.
The URL to retrieve events for.
The tag ID to retrieve events for.
The tag IDs to retrieve analytics for. Can be a single string or an array of strings.
Filter for QR code scans. If true, filter for QR code scans only. If false, filter for link clicks only. If undefined, return both.
Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
The number of records to retrieve.
Number of records to offset the results by.
The field to sort the results by.
The order to sort the results by.