#The AttributeValueDataPoint is one value of an attribute with how many visitors hold it object

AttributeValueDataPoint is one value of an attribute with how many visitors hold it

label

string

percentage

number (double)

visitorCount

integer (int32)

POST

/v1/analytics/attributes/distribution

Requires auth

#Get visitor attribute distribution

Returns how visitors are spread across the values of one attribute, for example how many gave each rating.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

key

string

limit

integer (int32)

Maximum number of values (default 10)

linkId

string

startDate

string (date-time)

#Response

200

Everything worked as expected.

data

array<object>

total

integer (int32)

#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 POST "https://api.linkbreakers.com/v1/analytics/attributes/distribution" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","key":"string","limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "key": "string",
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "label": "string",
      "percentage": 0,
      "visitorCount": 0
    }
  ],
  "total": 0
}

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

POST

/v1/analytics/attributes/metric

Requires auth

#Get visitor attribute metric

Returns count, average, minimum and maximum for a visitor attribute, plus how much of the audience carries it.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

Inclusive end timestamp

key

string

Attribute key, for example "rating"

linkId

string

Optional link filter (UUID). Attributes belong to the visitor rather than to a link, so this filters the audience: visitors who interacted with the link, whatever set the attribute.

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

audienceCount

integer (int32)

Visitors in the audience, whether or not they have the attribute

averageValue

number (double)

coverageRate

number (double)

Share of the audience carrying the attribute, 0 to 1

maxValue

number (double)

minValue

number (double)

totalCount

integer (int32)

Visitors carrying the attribute at all

usableCount

integer (int32)

Values that parsed as numbers, so the denominator for averages. Lower than total_count when some values do not match the attribute's declared type.

#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 POST "https://api.linkbreakers.com/v1/analytics/attributes/metric" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","key":"string","linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "key": "string",
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "audienceCount": 0,
  "averageValue": 0,
  "coverageRate": 0,
  "maxValue": 0,
  "minValue": 0,
  "totalCount": 0,
  "usableCount": 0
}

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

POST

/v1/analytics/attributes/values

Requires auth

#List visitor attribute values

Returns the individual recorded values of one attribute, most recent first. Intended for free text such as comments.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

key

string

limit

integer (int32)

Maximum number of values (default 50)

linkId

string

startDate

string (date-time)

#Response

200

Everything worked as expected.

data

array<object>

total

integer (int32)

#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 POST "https://api.linkbreakers.com/v1/analytics/attributes/values" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","key":"string","limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "key": "string",
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "recordedAt": "2026-10-06T12:27:58.469Z",
      "value": "string"
    }
  ],
  "total": 0
}

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

POST

/v1/analytics/breakdown

Requires auth

#Get dimension breakdown

Returns a ranked breakdown of events by any dimension (browser, platform, device type, country, city, visit type).

#Parameters

This endpoint does not accept any parameters.

#Request body

dimension

string

Dimension to break down by: "browser", "platform", "device_type", "country", "city", "visit_type"

endDate

string (date-time)

Inclusive end timestamp

limit

integer (int32)

Maximum number of results (default 10)

linkId

string

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

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

data

array<object>

Ordered list of dimension values by event count (descending)

total

integer (int32)

Total number of events in the date range

#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 POST "https://api.linkbreakers.com/v1/analytics/breakdown" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"dimension":"string","endDate":"2026-10-06T12:27:58.469Z","limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "dimension": "string",
  "endDate": "2026-10-06T12:27:58.469Z",
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "code": "string",
      "eventCount": 0,
      "label": "string",
      "percentage": 0
    }
  ],
  "total": 0
}

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

POST

/v1/analytics/devices

Requires auth

#Get device distribution

Retrieve event distribution across device types.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

Inclusive end timestamp

linkId

string

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

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

data

array<object>

Device type breakdown

totalEvents

integer (int32)

Total number of events in the date range

#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 POST "https://api.linkbreakers.com/v1/analytics/devices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "deviceType": "string",
      "eventCount": 0,
      "percentage": 0
    }
  ],
  "totalEvents": 0
}

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

POST

/v1/analytics/funnel

Requires auth

#Get workflow step funnel

Returns the workflow steps visitors reached, in distinct visitors, ordered from arrival to exit, with the conversion rate and drop-off at each step.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

Inclusive end timestamp

linkId

string

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

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

completionRate

number (double)

Conversion rate of the final step

entryVisits

string (int64)

Journeys that arrived; the denominator of every rate

steps

array<object>

Steps in the order a visitor meets them, arrival first

#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 POST "https://api.linkbreakers.com/v1/analytics/funnel" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "completionRate": 0,
  "entryVisits": "string",
  "steps": [
    {
      "branches": [
        {}
      ],
      "conversionRate": 0,
      "dropOffFromPrevious": "string",
      "identifiedVisitors": "string",
      "interactionRate": 0,
      "interactions": "string",
      "occurrences": "string",
      "stepAction": "string",
      "stepKind": "string",
      "visits": "string"
    }
  ]
}

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

POST

/v1/analytics/geo

Requires auth

#Get geographic breakdown

Retrieve geographic distribution of events grouped by country or city.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

Inclusive end timestamp

groupBy

string

Group by "country" or "city"

limit

integer (int32)

Maximum number of results (default 10)

linkId

string

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

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

data

array<object>

Ordered list of locations by event count (descending)

totalEvents

integer (int32)

Total number of events in the date range

#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 POST "https://api.linkbreakers.com/v1/analytics/geo" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","groupBy":"string","limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "groupBy": "string",
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "eventCount": 0,
      "location": "string",
      "percentage": 0
    }
  ],
  "totalEvents": 0
}

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

POST

/v1/analytics/hours

Requires auth

#Get hour of day distribution

Retrieve event counts aggregated by hour of day for identifying peak activity times.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

linkId

string

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

startDate

string (date-time)

#Response

200

Everything worked as expected.

data

array<object>

totalEvents

integer (int32)

#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 POST "https://api.linkbreakers.com/v1/analytics/hours" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.469Z","linkId":"string","startDate":"2026-10-06T12:27:58.469Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.469Z",
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.469Z"
}

Typical response

{
  "data": [
    {
      "eventCount": 0,
      "hour": 0
    }
  ],
  "totalEvents": 0
}

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

POST

/v1/analytics/timeseries

Requires auth

#Get grouped time series

Retrieve time-bucketed event counts grouped by a dimension like country, city, device type, or visit type.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

groupBy

string (enum)

GroupByDimension defines the available dimensions for grouping analytics data. Add new dimensions here as the platform grows.

Allowed values

GROUP_BY_DIMENSION_UNSPECIFIED

GROUP_BY_DIMENSION_COUNTRY

GROUP_BY_DIMENSION_CITY

GROUP_BY_DIMENSION_DEVICE_TYPE

GROUP_BY_DIMENSION_VISIT_TYPE

GROUP_BY_DIMENSION_BROWSER

GROUP_BY_DIMENSION_PLATFORM

intervalInMinutes

integer (int32)

limit

integer (int32)

Max number of groups to return (top N by volume). Default 5.

linkId

string

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

startDate

string (date-time)

#Response

200

Everything worked as expected.

series

array<object>

totalEvents

integer (int32)

Total events across all series

#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 POST "https://api.linkbreakers.com/v1/analytics/timeseries" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.470Z","groupBy":"GROUP_BY_DIMENSION_UNSPECIFIED","intervalInMinutes":0,"limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.470Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.470Z",
  "groupBy": "GROUP_BY_DIMENSION_UNSPECIFIED",
  "intervalInMinutes": 0,
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.470Z"
}

Typical response

{
  "series": [
    {
      "label": "string",
      "points": [
        {}
      ]
    }
  ],
  "totalEvents": 0
}

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

POST

/v1/analytics/top-links

Requires auth

#Get top performing links

Retrieve links ranked by event count for identifying best performing QR codes and links.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

limit

integer (int32)

Max number of links to return (default 10)

linkId

string

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

startDate

string (date-time)

#Response

200

Everything worked as expected.

data

array<object>

totalEvents

integer (int32)

#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 POST "https://api.linkbreakers.com/v1/analytics/top-links" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.470Z","limit":0,"linkId":"string","startDate":"2026-10-06T12:27:58.470Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.470Z",
  "limit": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.470Z"
}

Typical response

{
  "data": [
    {
      "eventCount": 0,
      "name": "string",
      "shortlink": "string"
    }
  ],
  "totalEvents": 0
}

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

POST

/v1/analytics/visitors

Requires auth

#Get visitor trends

Retrieve new vs returning visitor counts over time.

#Parameters

This endpoint does not accept any parameters.

#Request body

endDate

string (date-time)

Inclusive end timestamp

intervalInMinutes

integer (int32)

Bucket size in minutes (e.g. 60 for hourly, 1440 for daily)

linkId

string

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

startDate

string (date-time)

Inclusive start timestamp

#Response

200

Everything worked as expected.

data

array<object>

Time-bucketed visitor trend data

totalNew

integer (int32)

Total new visitors in the range

totalReturning

integer (int32)

Total returning visitors in the range

#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 POST "https://api.linkbreakers.com/v1/analytics/visitors" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"endDate":"2026-10-06T12:27:58.470Z","intervalInMinutes":0,"linkId":"string","startDate":"2026-10-06T12:27:58.470Z"}'

Sample payload (application/json)

{
  "endDate": "2026-10-06T12:27:58.470Z",
  "intervalInMinutes": 0,
  "linkId": "string",
  "startDate": "2026-10-06T12:27:58.470Z"
}

Typical response

{
  "data": [
    {
      "newVisitorCount": 0,
      "returningVisitorCount": 0,
      "timestamp": "2026-10-06T12:27:58.482Z"
    }
  ],
  "totalNew": 0,
  "totalReturning": 0
}

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

Analytics Data

#The AttributeValueDataPoint is one value of an attribute with how many visitors hold it object

#Get visitor attribute distribution

#Parameters

#Request body

#Response

#Error response

#Get visitor attribute metric

#Parameters

#Request body

#Response

#Error response

#List visitor attribute values

#Parameters

#Request body

#Response

#Error response

#Get dimension breakdown

#Parameters

#Request body

#Response

#Error response

#Get device distribution

#Parameters

#Request body

#Response

#Error response

#Get workflow step funnel

#Parameters

#Request body

#Response

#Error response

#Get geographic breakdown

#Parameters

#Request body

#Response

#Error response

#Get hour of day distribution

#Parameters

#Request body

#Response

#Error response

#Get grouped time series

#Parameters

#Request body

Allowed values

#Response

#Error response

#Get top performing links

#Parameters

#Request body

#Response

#Error response

#Get visitor trends

#Parameters

#Request body

#Response

#Error response