Retrieve analytics
Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the event and type query parameters.
Query Parameters
The parameter to group the analytics data points by. Defaults to 'count' if undefined. Some values depend on the workspace plan and answer 403 forbidden on a plan without them: referers and referer_urls need the Starter, Pro, Business, Scale, or Enterprise plan; devices, browsers, and os need the Starter, Pro, Business, Scale, or Enterprise plan; utm_sources, utm_mediums, utm_campaigns, utm_contents, and utm_terms need the Pro, Business, Scale, or Enterprise plan.
timeseries, clicks, count, totals, top_urls, top_links, top_qrcodes, top_pages, top_events, scans, views, country, city, region, devices, browsers, os, referers, referer_urls, trend_live, kpis, analytics, continents, countries, cities, clicks, scans, views, leads, sales, composite, utm_sources, utm_mediums, utm_campaigns, utm_contents, utm_terms, trigger The country to retrieve analytics for.
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 Response
Analytics data
- AnalyticsCount · object
- AnalyticsTimeseries · object[]
- AnalyticsContinents · object[]
- AnalyticsCountries · object[]
- AnalyticsRegions · object[]
- AnalyticsCities · object[]
- AnalyticsDevices · object[]
- AnalyticsBrowsers · object[]
- AnalyticsOS · object[]
- AnalyticsReferers · object[]
- AnalyticsRefererUrls · object[]
- AnalyticsTopLinks · object[]
- AnalyticsTopUrls · object[]
- AnalyticsTrigger · object[]

