Join us now
← Back to API Reference overview

Metrics

Endpoints for managing metrics in Linkbreakers. These endpoints allow you to retrieve metrics for the workspace and events.

Shortcut: ⌘K

#The Workspace Metric object

Metrics regarding the workspace itself

totalEvents

integer (int32)

totalLinks

integer (int32)

totalMembers

integer (int32)

totalMonthlyEvents

integer (int32)
GET/v1/metrics/event-daysRequires auth

#Get event days

Month is YYYY-MM format and timezone is required to match client expectations

#Parameters

query parameters

month

stringquery

YYYY-MM format

timezone

stringquery

linkId

stringquery

Optional filtering by link ID

#Response

200

Everything worked as expected.

days

array<integer (int32)>

#Error response

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

error

objectRequired

Wrapped error response.

GET/v1/metrics/eventsRequires auth

#Get events metric

#Parameters

query parameters

startDate

string (date-time)query

endDate

string (date-time)query

linkId

stringquery

UUID format

#Response

200

Everything worked as expected.

averageLeadScore

number (double)

firstAt

string (date-time)

lastAt

string (date-time)

topCity

string

topCountry

string

topDeviceType

string (enum)
Allowed values
DEVICE_TYPE_UNSPECIFIED
DEVICE_TYPE_NATIVE
DEVICE_TYPE_MOBILE
DEVICE_TYPE_TABLET
DEVICE_TYPE_DESKTOP
DEVICE_TYPE_BOT
DEVICE_TYPE_UNKNOWN

totalCities

integer (int32)

totalCountries

integer (int32)

totalDeviceTypes

integer (int32)

totalEvents

integer (int32)

#Error response

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

This is typically shown on the live dashboard

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

totalEvents

integer (int32)

totalLinks

integer (int32)

totalMembers

integer (int32)

totalMonthlyEvents

integer (int32)

#Error response

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

error

objectRequired

Wrapped error response.