#The Get Event Days Response object
GetEventDaysResponse enumerates the calendar days with event activity for the chosen month.
days
array<integer (int32)>Calendar days (1-31) where at least one event occurred in the requested month
Endpoints for analyzing workspace activity within Linkbreakers, covering rolling event totals, audience reach, and calendar heatmaps.
GetEventDaysResponse enumerates the calendar days with event activity for the chosen month.
days
array<integer (int32)>Calendar days (1-31) where at least one event occurred in the requested month
/v1/metrics/event-days
Requires authMonth is YYYY-MM format and timezone is required to match client expectations
month
stringqueryMonth to summarize in YYYY-MM format YYYY-MM format
timezone
stringqueryWorkspace timezone used to normalize scans into calendar days
linkId
stringqueryOptional filter to only include events for a given link (UUID) Optional filtering by link ID
/v1/metrics/events
Requires authstartDate
string (date-time)queryInclusive start timestamp for the aggregation
endDate
string (date-time)queryInclusive end timestamp for the aggregation
linkId
stringqueryOptional link filter (UUID); when omitted aggregates workspace-wide UUID format
Everything worked as expected.
averageLeadScore
number (double)Average lead score (excluding null values)
firstAt
string (date-time)Timestamp of the first event in the aggregated range
lastAt
string (date-time)Timestamp of the last event in the aggregated range
topCity
stringThe top city
topCountry
stringThe top country (ISO code or name)
topDeviceType
string (enum)The top device type
DEVICE_TYPE_UNSPECIFIED
Device type not specified or not yet detected
DEVICE_TYPE_NATIVE
Native QR scanner (no browser capabilities reported)
DEVICE_TYPE_MOBILE
Mobile handset browser
DEVICE_TYPE_TABLET
Tablet browser
DEVICE_TYPE_DESKTOP
Desktop or laptop browser
DEVICE_TYPE_BOT
Automated agent or bot traffic
DEVICE_TYPE_UNKNOWN
Unable to classify the device
totalCities
integer (int32)Total number of unique cities seen in the events
totalCountries
integer (int32)Total number of unique countries seen in the events
totalDeviceTypes
integer (int32)Number of unique device types
totalEvents
integer (int32)Total number of events matching the query window
All endpoints may return an unexpected error payload when a request cannot be processed.
error
objectRequiredWrapped error response.
/v1/metrics/workspace
Requires authThis is typically shown on the live dashboard
This endpoint does not accept any parameters.
Everything worked as expected.
totalEvents
integer (int32)Historical count of events generated by the workspace
totalLinks
integer (int32)Number of short links created within the workspace
totalMembers
integer (int32)Total number of active members in the workspace
totalMonthlyEvents
integer (int32)Events created within the current rolling month window
All endpoints may return an unexpected error payload when a request cannot be processed.
error
objectRequiredWrapped error response.