Join us now
← Back to API Reference overview

Events

Endpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events.

Shortcut: ⌘K

#The Event object

Event represents a tracking event

action

string (enum)
Allowed values
ACTION_UNSPECIFIED
ACTION_SCAN
ACTION_RESCAN

createdAt

string (date-time)

destination

string

device

object

deviceId

string

entrypoint

string

httpMethod

string (enum)
Allowed values
HTTP_METHOD_UNSPECIFIED
HTTP_METHOD_GET
HTTP_METHOD_POST
HTTP_METHOD_PUT
HTTP_METHOD_DELETE
HTTP_METHOD_PATCH
HTTP_METHOD_OPTIONS
HTTP_METHOD_HEAD

id

string

leadScore

object

leadScoreId

string

link

object

Link represents a link in the system.

linkId

string

scannedAt

string (date-time)

triggeredBy

string (enum)
Allowed values
TRIGGERED_BY_UNSPECIFIED
TRIGGERED_BY_VISITOR

updatedAt

string (date-time)

visitor

object

visitorId

string

workspace

object

workspaceId

string
GET/v1/events/listRequires auth

#List events

#Parameters

query parameters

linkId

stringquery

Optional

startDate

string (date-time)query

endDate

string (date-time)query

responseFormat

stringquery

limit

integer (int32)query

Maximum number of events to return (default: 100, max: 1000)

offset

integer (int32)query

Number of events to skip for pagination

include

array<string>query

Optional list of relationships to include: visitor, device, link, workspace, lead_score

#Response

200

Everything worked as expected.

csv

object

json

object

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.