Join us now
← Back to API Reference overview

Workspace Metrics

Endpoints for analyzing workspace activity within Linkbreakers, covering rolling event totals, audience reach, and calendar heatmaps.

Shortcut: ⌘K

#EventsMetric

Aggregated analytics calculated on demand for time windows, giving Linkbreakers UIs headline numbers without exposing raw events.

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

string

The top city

topCountry

string

The top country (ISO code or name)

topDeviceType

string (enum)

The top device type

Allowed values
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

GET/v1/metrics/eventsRequires auth

#Get events metric

Retrieve aggregated event analytics for the provided time window and optional link filter.

#Parameters

query parameters

startDate

string (date-time)query

Inclusive start timestamp for the aggregation

endDate

string (date-time)query

Inclusive end timestamp for the aggregation

linkId

stringquery

Optional link filter (UUID); when omitted aggregates workspace-wide UUID format

#Response

200

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

string

The top city

topCountry

string

The top country (ISO code or name)

topDeviceType

string (enum)

The top device type

Allowed values
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

#Error response

400-599

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

error

objectRequired

Wrapped error response.

GET/v1/metrics/workspaceRequires auth

#Get workspace metric

Return high-level workspace totals covering members, links, and activity volume.

#Parameters

This endpoint does not accept any parameters.

#Response

200

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

#Error response

400-599

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

error

objectRequired

Wrapped error response.