dub.analytics.retrieve
Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the event and type query parameters.
Analytics endpoints require a Pro plan subscription or higher.
Arguments
The type of event to retrieve analytics for. Available options: clicks,
leads, and sales.
The parameter to group the analytics data points by. Defaults to ‘count’ if
undefined. Available options: count, timeseries, countries, cities,
devices, browsers, os, referers, top_links, top_urls, and
trigger.
The domain of the short link.
The short link slug.
The interval to retrieve analytics for.
Available options are 1h, 24h, 7d, 30d, 90d, ytd, 1y, and all.
Takes precedence over start and end.
The start date to retrieve analytics for.
Cannot be earlier than September 22, 2022.
The start date to retrieve analytics for.
Cannot be in the future. If not provided, defaults to the current date.
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
The city to retrieve analytics for.
The device to retrieve analytics for.
The browser to retrieve analytics for.
The OS to retrieve analytics for.
The referer to retrieve analytics for.
The URL to retrieve analytics for.
Whether to exclude the root link from the response.
The tag ID to retrieve analytics for.
Response
The name of the browser
The number of clicks from this browser
Was this page helpful?