Analytics endpoints require a Pro plan subscription or higher.

​
Arguments

event
enum
default: "clicks"

The type of event to retrieve analytics for. Available options: clicks, leads, sales and composite.

groupBy
enum

The parameter to group the analytics data points by. Defaults to ‘count’ if undefined. Available options: count, timeseries, continents, regions, countries, cities, devices, browsers, os, trigger, triggers, referers, referer_urls, top_links, top_urls.

domain
string

The domain of the short link.

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>

The interval to retrieve analytics for.

Available options are 1h, 24h, 7d, 30d, 90d, ytd, 1y, and all.

Takes precedence over start and end.

start
string

The start date to retrieve analytics for.

Cannot be earlier than September 22, 2022.

end
string

The start date to retrieve analytics for.

Cannot be in the future. If not provided, defaults to the current date.

timezone
string

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

continent
string

The continent to retrieve analytics for.

Available options are AF, AN, AS, EU, NA, OC, and SA.

country
enum<string>

The country to retrieve analytics 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

city
string

The city to retrieve analytics for.

region
string

The ISO 3166-2 region code 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. Available options: qr, link. If undefined, return both QR and link clicks.

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

The tag ID to retrieve analytics for.

tagIds
string | string[]

The tag IDs to retrieve analytics for. Can be a single string or an array of strings.

qr
boolean

Filter for QR code scans. If true, filter for QR code scans only. If false, filter for link clicks 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.

Was this page helpful?

Delete ManyList