#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)

DeviceType represents the physical form factor of the device. This describes the hardware category (phone, tablet, laptop, etc.), NOT who or what is operating it — see DeviceActor for that.

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_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

Example object

{
  "averageLeadScore": 0,
  "firstAt": "2026-10-05T03:43:38.104Z",
  "lastAt": "2026-10-05T03:43:38.104Z",
  "topCity": "string",
  "topCountry": "string",
  "topDeviceType": "DEVICE_TYPE_DESKTOP",
  "totalCities": 0,
  "totalCountries": 0,
  "totalDeviceTypes": 0,
  "totalEvents": 0
}

GET

/v1/metrics/events

Requires 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

string

query

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)

DeviceType represents the physical form factor of the device. This describes the hardware category (phone, tablet, laptop, etc.), NOT who or what is operating it — see DeviceActor for that.

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_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

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/metrics/events?startDate={startDate}&endDate={endDate}&linkId={linkId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "averageLeadScore": 0,
  "firstAt": "2026-10-05T03:43:38.103Z",
  "lastAt": "2026-10-05T03:43:38.103Z",
  "topCity": "string",
  "topCountry": "string",
  "topDeviceType": "DEVICE_TYPE_DESKTOP",
  "totalCities": 0,
  "totalCountries": 0,
  "totalDeviceTypes": 0,
  "totalEvents": 0
}

Base URL: https://api.linkbreakers.com

GET

/v1/metrics/workspace

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

tokenCreditsLimit

integer (int32)

Monthly platform credits limit for the current cycle (0 means unlimited)

tokenCreditsUsed

integer (int32)

Monthly platform credits consumed in the current cycle

topupCreditsLimit

integer (int32)

Top-up credits total purchased (available = limit - used)

topupCreditsUsed

integer (int32)

Top-up credits consumed (from purchased credit packs)

totalDirectories

integer (int32)

Total number of directories (including subdirectories) in the workspace

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

totalPageThemeTemplates

integer (int32)

Number of page theme templates owned by the workspace

totalQrcodeTemplates

integer (int32)

Number of QR code templates owned by the workspace

#Error response

400-599

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

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/metrics/workspace" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "tokenCreditsLimit": 0,
  "tokenCreditsUsed": 0,
  "topupCreditsLimit": 0,
  "topupCreditsUsed": 0,
  "totalDirectories": 0,
  "totalEvents": 0,
  "totalLinks": 0,
  "totalMembers": 0,
  "totalMonthlyEvents": 0,
  "totalPageThemeTemplates": 0,
  "totalQrcodeTemplates": 0
}

Base URL: https://api.linkbreakers.com

GET

/v1/metrics/workspace/insight

Requires auth

#Get workspace insight

Return workspace usage insights including the preferred link type based on historical link creation patterns.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

preferredLinkType

string (enum)

PreferredLinkType indicates the dominant link creation pattern for a workspace.

Allowed values

PREFERRED_LINK_TYPE_URL

Default when no links exist yet — treated as URL

PREFERRED_LINK_TYPE_CONTACT_CARD

Workspace primarily creates contact card links

PREFERRED_LINK_TYPE_SOCIAL_LINKS_PAGE

Workspace primarily creates social links pages

PREFERRED_LINK_TYPE_MIX

Workspace uses a mix of different link types

#Error response

400-599

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

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/metrics/workspace/insight" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "preferredLinkType": "PREFERRED_LINK_TYPE_URL"
}

Base URL: https://api.linkbreakers.com

Workspace Metrics

#EventsMetric

Allowed values

#Get events metric

#Parameters

query parameters

#Response

Allowed values

#Error response

#Get workspace metric

#Parameters

#Response

#Error response

#Get workspace insight

#Parameters

#Response

Allowed values

#Error response