Skip to main content
GET
/
events
JavaScript
import Codeqr from '@codeqr/ts';

const client = new Codeqr({
  apiKey: 'My API Key',
});

const events = await client.events.list();

console.log(events);
[
  {
    "event": "click",
    "click": {
      "id": "<string>",
      "url": "<string>",
      "continent": "<string>",
      "country": "<string>",
      "city": "<string>",
      "device": "<string>",
      "browser": "<string>",
      "os": "<string>",
      "referer": "<string>",
      "refererUrl": "<string>",
      "type": "<string>",
      "ip": "<string>"
    },
    "link": {
      "id": "<string>",
      "domain": "<string>",
      "key": "<string>",
      "expiredUrl": "<string>",
      "flexible": false,
      "password": "<string>",
      "externalId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "image": "<string>",
      "video": "<string>",
      "ios": "<string>",
      "android": "<string>",
      "geo": {},
      "tagId": "<string>",
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "red"
        }
      ],
      "folderId": "<string>",
      "comments": "<string>",
      "notificationToken": "<string>",
      "utm_source": "<string>",
      "utm_medium": "<string>",
      "utm_campaign": "<string>",
      "utm_term": "<string>",
      "utm_content": "<string>",
      "userId": "<string>",
      "projectId": "<string>",
      "clicks": 0,
      "leads": 0,
      "sales": 0,
      "saleAmount": 0,
      "lastClicked": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "preRedirection": false,
      "isFormMandatory": false,
      "filled": false,
      "url": "<string>",
      "archived": true,
      "expiresAt": "<string>",
      "trackConversion": true,
      "doIndex": true,
      "proxy": true,
      "rewrite": true,
      "publicStats": true,
      "shortLink": "<string>",
      "qrCode": "<string>",
      "pageId": "<string>",
      "pageUrl": "<string>"
    },
    "click_id": "<string>",
    "link_id": "<string>",
    "domain": "<string>",
    "key": "<string>",
    "url": "<string>",
    "continent": "<string>",
    "country": "<string>",
    "city": "<string>",
    "device": "<string>",
    "browser": "<string>",
    "os": "<string>",
    "type": "<string>",
    "ip": "<string>",
    "timestamp": "<string>"
  }
]
Events endpoints require a Business plan subscription or higher.

Authorizations

​
Authorization
string
header
required

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,
scans,
views
​
domain
string

The domain of the short link.

​
key
string

The short link slug.

​
linkId
string

The unique ID of the short link on CodeQR.

​
qrcodeId
string

The unique ID of the QR code on CodeQR.

​
pageId
string

The unique ID of the page on CodeQR.

​
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.

​
end
string

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

​
timezone
string
default:UTC

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

Example:

"America/New_York"

​
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.

Example:

"New York"

​
device
string

The device to retrieve analytics for.

Example:

"Desktop"

​
browser
string

The browser to retrieve analytics for.

Example:

"Chrome"

​
os
string

The OS to retrieve analytics for.

Example:

"Windows"

​
referer
string

The referer to retrieve analytics for.

Example:

"google.com"

​
url
string

The URL to retrieve analytics for.

​
excludeRoot
boolean

Whether to exclude the root link from the response.

​
root
boolean

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

​
tagId
string

The tag ID to retrieve analytics for.

​
type
string

The type of analytics to retrieve.

​
types
string

The types of analytics to retrieve.

​
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

A list of events

  • ClickEvent
  • LeadEvent
  • SaleEvent
​
event
enum<string>
required
Available options:
click
​
click
object
required
​
link
object
required
​
click_id
string
required
deprecated

Deprecated. Use click.id instead.

​
link_id
string
required
deprecated

Deprecated. Use link.id instead.

​
domain
string
required
deprecated

Deprecated. Use link.domain instead.

​
key
string
required
deprecated

Deprecated. Use link.key instead.

​
url
string
required
deprecated

Deprecated. Use click.url instead.

​
continent
string
required
deprecated

Deprecated. Use click.continent instead.

​
country
string
required
deprecated

Deprecated. Use click.country instead.

​
city
string
required
deprecated

Deprecated. Use click.city instead.

​
device
string
required
deprecated

Deprecated. Use click.device instead.

​
browser
string
required
deprecated

Deprecated. Use click.browser instead.

​
os
string
required
deprecated

Deprecated. Use click.os instead.

​
type
string
required
deprecated

Deprecated. Use click.qr instead.

​
ip
string
required
deprecated

Deprecated. Use click.ip instead.

​
timestamp
string