---
title: "Events API Reference"
description: "Endpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events."
canonical: "https://linkbreakers.com/help/api/events"
---

# Events

Endpoints for managing events in Linkbreakers. These endpoints allow you to collect data and list events.

## Events

## [#](#events-object)The Event object

Records each scan or workflow action Linkbreakers processes, stitching together visitor, device, link, and routing details so analytics and automations stay in sync.

action

string (enum)

The type of event action

##### Allowed values

`ACTION_UNSPECIFIED`

Action not specified

`ACTION_SCAN`

QR code scan

`ACTION_CLICK`

First-time direct link click

createdAt

string (date-time)

Timestamp when the event object was created

destination

string

Final resolved destination after workflow evaluation

destinationAction

string (enum)

leads to a next step, not straight out. Records which button the visitor pressed, so use it over SOCIAL\_LINKS\_PAGE when that choice is worth measuring or when a branch needs to do more than redirect. This is the menu step: for several documents or PDFs, give each one a button connected to an OPEN\_MEDIA step for media uploaded to the media library, or to a CLIENT\_REDIRECT when the document is already hosted at a URL. the common case, not the only one: app stores, docs, booking pages and storefronts all work, and the name is the only thing about it that is social. It is an exit step, so the visitor leaves from here. visitor automatically. It carries no list of destinations, so a page that should offer a choice between two or more places is not this step. Use SOCIAL\_LINKS\_PAGE when the choices leave for external URLs, or MULTI\_LINK when each choice continues into more workflow. Never put links, documents or PDFs on it: it is a message, nothing else. an image (PNG, JPEG, WebP, SVG) or an MP4 video. The visitor is sent straight to the media, with no page of its own. Any media of the library can be opened: it is uploaded once and referenced by its media\_id; swapping it means pointing the step at another media item, and the QR code never changes.

##### Allowed values

`EVENT_ACTION_UNSPECIFIED`

Event action not specified

`EVENT_ACTION_CLIENT_REDIRECT`

Redirect visitors to a destination URL

`EVENT_ACTION_LINK_VISIT`

Entry step triggered when the link is visited.

`EVENT_ACTION_PASSWORD_VERIFY`

Require visitors to enter a password before proceeding

`EVENT_ACTION_FORM_SUBMIT`

Present a data collection form to visitors

`EVENT_ACTION_CONTACT_CARD`

Generate a vCard (VCF) response with contact information

`EVENT_ACTION_MULTI_LINK`

A page of buttons where each one continues into more workflow: the button

`EVENT_ACTION_VISIT_TYPE_CONDITION`

Route visitors based on whether it's a first or returning visit

`EVENT_ACTION_COUNTRY_CONDITION`

Route visitors based on their country location

`EVENT_ACTION_DAY_OF_WEEK_CONDITION`

Route visitors based on day of week

`EVENT_ACTION_TIME_OF_DAY_CONDITION`

Route visitors based on time of day

`EVENT_ACTION_DAY_OF_MONTH_CONDITION`

Route visitors based on day of month

`EVENT_ACTION_SPECIFIC_DATE_CONDITION`

Route visitors based on specific calendar dates

`EVENT_ACTION_SOCIAL_LINKS_PAGE`

A page of buttons that each leave for an external URL. Social profiles are

`EVENT_ACTION_DEVICE_TYPE_CONDITION`

Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)

`EVENT_ACTION_DEVICE_PLATFORM_CONDITION`

Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)

`EVENT_ACTION_DEVICE_BROWSER_CONDITION`

Route visitors based on browser family (e.g. Chrome, Safari, Firefox)

`EVENT_ACTION_DEVICE_BRAND_CONDITION`

Route visitors based on hardware brand (e.g. Apple, Samsung, Google)

`EVENT_ACTION_DEVICE_ACTOR_CONDITION`

Route visitors based on actor classification (e.g. HUMAN, BOT, AGENT)

`EVENT_ACTION_VISITOR_DATA_CONDITION`

Route visitors based on their profile data or custom attributes

`EVENT_ACTION_THANK_YOU_PAGE`

Display a final thank you / completion message (exit step)

`EVENT_ACTION_MESSAGE_PAGE`

Text with ONE way onward: a single button, or a timer that moves the

`EVENT_ACTION_OPEN_MEDIA`

Hand the visitor one piece of uploaded media, opened in their browser (exit step): a PDF,

device

object

Tracks the fingerprint of a visitor's hardware/software so Linkbreakers can de-duplicate scans, enrich analytics, and power security heuristics.

deviceId

string

Device fingerprint associated with the event (UUID)

entrypoint

string

Entrypoint URL that received the request (short link)

httpMethod

string (enum)

The HTTP method used when the event was generated

##### Allowed values

`HTTP_METHOD_UNSPECIFIED`

HTTP method not specified

`HTTP_METHOD_GET`

`HTTP_METHOD_POST`

`HTTP_METHOD_PUT`

`HTTP_METHOD_DELETE`

`HTTP_METHOD_PATCH`

`HTTP_METHOD_OPTIONS`

`HTTP_METHOD_HEAD`

id

string

Unique identifier for the event object (UUID)

journey

object

How far one visit got through a workflow. Conditions are not counted, since a visitor never sees them.

link

object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

linkId

string

Identifier of the link producing the event (UUID)

scannedAt

string (date-time)

When the QR code or link was accessed

traces

array<object>

Workflow step traces for engagement tracking (included only on demand)

triggeredBy

string (enum)

The actor that triggered the event

##### Allowed values

`TRIGGERED_BY_UNSPECIFIED`

Trigger source not specified

`TRIGGERED_BY_VISITOR`

Visitor initiated the scan (as opposed to system-generated)

updatedAt

string (date-time)

Timestamp when the event object was last updated (e.g. when enrichment completed)

visitType

string (enum)

The type of visit for a given event

##### Allowed values

`VISIT_TYPE_UNSPECIFIED`

Visit type not specified

`VISIT_TYPE_FIRST`

First time this device reaches this link

`VISIT_TYPE_RETURNING`

Returning device reaching this link again

visitor

object

Captures the cross-link profile Linkbreakers builds for someone who scans or clicks, combining reserved identity fields, attributed devices, events, and custom traits gathered from forms.

visitorId

string

Visitor profile associated with the event (UUID)

workspace

object

Serves as the tenant boundary in Linkbreakers, grouping links, members, settings, billing state, and analytics under a single organization's environment.

workspaceId

string

Identifier of the owning workspace (UUID)

[Learn moreLearn more about events in Linkbreakers](https://linkbreakers.com/help/article/what-is-an-event)

Example object

```json
{
  "action": "ACTION_SCAN",
  "createdAt": "2026-10-25T17:54:38.178Z",
  "destination": "https://brand.example.com/checkout",
  "destinationAction": "EVENT_ACTION_CLIENT_REDIRECT",
  "device": {
    "asn": 7922,
    "browserLanguage": "en-US,en;q=0.9",
    "browserName": "Chrome",
    "browserVersion": "99.0.4844.51",
    "city": "New York",
    "country": "US",
    "createdAt": "2026-10-25T17:54:38.178Z",
    "deviceActor": "DEVICE_ACTOR_HUMAN",
    "deviceActorName": "GPTBot",
    "deviceActorOrigin": "OpenAI",
    "deviceBrand": "Apple",
    "deviceConcurrency": 4,
    "deviceMemory": 6,
    "deviceName": "iPhone 14 Pro",
    "deviceType": "DEVICE_TYPE_MOBILE",
    "gpu": "Apple GPU",
    "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
    "ipAddress": "203.0.113.42",
    "isp": "Comcast Cable Communications",
    "lastUsedAt": "2026-10-25T17:54:38.178Z",
    "networkBandwidth": 10,
    "networkConnection": "4g",
    "networkRtt": 50,
    "platformName": "macOS",
    "platformVersion": "10.15.7",
    "region": "CRF",
    "screenHeight": 1117,
    "screenRatio": 1.55,
    "screenWidth": 1728,
    "state": "NY",
    "timezone": "Europe/London",
    "touchScreen": true,
    "updatedAt": "2026-10-25T17:54:38.178Z",
    "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
  },
  "deviceId": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
  "entrypoint": "https://linkbreak.ing/4BnH-R19p",
  "httpMethod": "HTTP_METHOD_GET",
  "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
  "journey": {
    "completed": false,
    "stepsReached": 0,
    "stepsTotal": 0
  },
  "link": {
    "createdAt": "2026-10-25T17:54:38.178Z",
    "customDomain": {
      "activatedAt": "2026-10-25T17:54:38.179Z",
      "certificateExpiresAt": "2026-10-25T17:54:38.179Z",
      "cloudflareHostnameStatus": "active",
      "cloudflareSslStatus": "pending_validation",
      "createdAt": "2026-10-25T17:54:38.179Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "lastCheckedAt": "2026-10-25T17:54:38.179Z",
      "lastError": "string",
      "name": "example.com",
      "rootDestination": "https://example.com",
      "status": "STATUS_ACTIVE",
      "updatedAt": "2026-10-25T17:54:38.179Z",
      "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "directoryId": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
    "entrypoint": "https://linkbreak.ing/4BnH-R19p",
    "eventCount": 128,
    "expiredDestination": "https://example.com/campaign-over",
    "expiresAt": "2026-12-31T23:59:59Z",
    "fallbackDestination": "https://brand.example.com/fallback",
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "metadata": {},
    "name": "string",
    "pageTheme": {
      "badgeEnabled": false,
      "badgeIconColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "badgeId": "string",
      "badgeShape": "PAGE_THEME_BADGE_SHAPE_UNSPECIFIED",
      "bodyFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "familyStack": "\"Gill Sans\", \"Trebuchet MS\", sans-serif",
        "fontSize": 0,
        "italic": false
      },
      "canvasColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "canvasCoverId": "string",
      "canvasCoverMode": "PAGE_THEME_BACKGROUND_COVER_MODE_UNSPECIFIED",
      "containerConfig": {
        "backgroundColor": {},
        "borderColor": {},
        "borderSize": 0,
        "borderStyle": "PAGE_THEME_BORDER_STYLE_UNSPECIFIED",
        "opacity": 0,
        "variant": "PAGE_THEME_CONTAINER_VARIANT_UNSPECIFIED"
      },
      "containerEnabled": false,
      "createdAt": "2026-10-25T17:54:38.179Z",
      "elementColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "THEME_COLOR_TYPE_UNSPECIFIED"
      },
      "elementFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "familyStack": "\"Gill Sans\", \"Trebuchet MS\", sans-serif",
        "fontSize": 0,
        "italic": false
      },
      "footerLogoEnabled": false,
      "footerLogoId": "string",
      "id": "string",
      "titleFont": {
        "bold": false,
        "color": {},
        "family": "PAGE_THEME_FONT_FAMILY_UNSPECIFIED",
        "familyStack": "\"Gill Sans\", \"Trebuchet MS\", sans-serif",
        "fontSize": 0,
        "italic": false
      },
      "updatedAt": "2026-10-25T17:54:38.179Z",
      "workspaceId": "string"
    },
    "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "pageThemeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "purpose": "string",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {}
      },
      "centralImageMargin": 0,
      "centralImageMediaId": "string",
      "centralImageSignedUrl": "https://example.com",
      "centralImageSize": 0,
      "cornersDotOptions": {
        "themeColor": {},
        "type": "CORNERS_DOT_TYPE_UNSPECIFIED"
      },
      "cornersSquareOptions": {
        "themeColor": {},
        "type": "CORNERS_SQUARE_TYPE_UNSPECIFIED"
      },
      "createdAt": "2026-10-25T17:54:38.179Z",
      "dotsOptions": {
        "themeColor": {},
        "type": "DOTS_TYPE_UNSPECIFIED"
      },
      "errorCorrectionLevel": "string",
      "height": 0,
      "hideBackgroundDots": false,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-10-25T17:54:38.179Z",
      "width": 0
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "qrcodeEnabled": true,
    "qrcodePendingUpdateSince": "2026-10-25T17:54:38.179Z",
    "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
    "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "shortlink": "4BnH-R19p",
    "tags": [
      {
        "createdAt": "2026-10-25T17:54:38.179Z",
        "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
        "name": "string",
        "updatedAt": "2026-10-25T17:54:38.179Z"
      }
    ],
    "updatedAt": "2026-10-25T17:54:38.179Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  },
  "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "scannedAt": "2026-10-25T17:54:38.179Z",
  "traces": [
    {
      "completedAt": "2026-10-25T17:54:38.179Z",
      "createdAt": "2026-10-25T17:54:38.179Z",
      "eventId": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
      "id": "2a7b8c9d-1e2f-4a5b-9c8d-7e6f5a4b3c2d",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "savedAttributes": {},
      "stepAction": "contact_form",
      "stepData": {
        "contactCard": {},
        "countryCondition": {},
        "dayOfMonthCondition": {},
        "dayOfWeekCondition": {},
        "deviceActorCondition": {},
        "deviceBrandCondition": {},
        "deviceBrowserCondition": {},
        "devicePlatformCondition": {},
        "deviceTypeCondition": {},
        "entryAccess": {},
        "form": {},
        "identifyVisitor": {},
        "media": {},
        "multiLink": {},
        "password": {},
        "redirect": {},
        "socialLinks": {},
        "specificDateCondition": {},
        "timeOfDayCondition": {},
        "visitTypeCondition": {},
        "visitorDataCondition": {}
      },
      "stepKind": "INTERACTION",
      "updatedAt": "2026-10-25T17:54:38.179Z",
      "visitorId": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ],
  "triggeredBy": "TRIGGERED_BY_VISITOR",
  "updatedAt": "2026-10-25T17:54:38.179Z",
  "visitType": "VISIT_TYPE_FIRST",
  "visitor": {
    "attributes": [
      {
        "boolValue": false,
        "dateValue": "2026-10-25T17:54:38.179Z",
        "key": "rating",
        "numberValue": 0,
        "type": "VISITOR_ATTRIBUTE_TYPE_UNSPECIFIED",
        "value": "8"
      }
    ],
    "createdAt": "2026-10-25T17:54:38.179Z",
    "deviceCount": 2,
    "devices": [
      {
        "asn": 7922,
        "browserLanguage": "en-US,en;q=0.9",
        "browserName": "Chrome",
        "browserVersion": "99.0.4844.51",
        "city": "New York",
        "country": "US",
        "createdAt": "2026-10-25T17:54:38.179Z",
        "deviceActor": "DEVICE_ACTOR_HUMAN",
        "deviceActorName": "GPTBot",
        "deviceActorOrigin": "OpenAI",
        "deviceBrand": "Apple",
        "deviceConcurrency": 4,
        "deviceMemory": 6,
        "deviceName": "iPhone 14 Pro",
        "deviceType": "DEVICE_TYPE_MOBILE",
        "gpu": "Apple GPU",
        "id": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
        "ipAddress": "203.0.113.42",
        "isp": "Comcast Cable Communications",
        "lastUsedAt": "2026-10-25T17:54:38.179Z",
        "networkBandwidth": 10,
        "networkConnection": "4g",
        "networkRtt": 50,
        "platformName": "macOS",
        "platformVersion": "10.15.7",
        "region": "CRF",
        "screenHeight": 1117,
        "screenRatio": 1.55,
        "screenWidth": 1728,
        "state": "NY",
        "timezone": "Europe/London",
        "touchScreen": true,
        "updatedAt": "2026-10-25T17:54:38.179Z",
        "userAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.4 Mobile/15E148 Safari/604.1"
      }
    ],
    "email": "sam.visitor@example.com",
    "events": [
      {
        "action": "SCAN",
        "createdAt": "2026-10-25T17:54:38.179Z",
        "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
        "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "scannedAt": "2026-10-25T17:54:38.179Z",
        "visitType": "FIRST"
      }
    ],
    "firstName": "Sam",
    "id": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
    "lastName": "Rivera",
    "links": [
      {
        "entrypoint": "https://linkbreak.ing/4BnH-R19p",
        "eventCount": 12,
        "firstVisitedAt": "2026-10-25T17:54:38.179Z",
        "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "lastVisitedAt": "2026-10-25T17:54:38.179Z",
        "name": "Spring Launch Campaign",
        "shortlink": "4BnH-R19p"
      }
    ],
    "phone": "+15551234567",
    "qrcodeCount": 3,
    "updatedAt": "2026-10-25T17:54:38.179Z",
    "visitCount": 42,
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  },
  "visitorId": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
  "workspace": {
    "country": "string",
    "createdAt": "2026-10-25T17:54:38.179Z",
    "description": "string",
    "digestFrequency": "DIGEST_FREQUENCY_UNSPECIFIED",
    "enforceMfa": false,
    "enrollRequestedAt": "2026-10-25T17:54:38.179Z",
    "faq": "string",
    "id": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0",
    "inactiveSince": "2026-10-25T17:54:38.179Z",
    "isSandbox": false,
    "linkSettingId": "fbb5c4b6-2a10-4f35-8cb1-60c613a92d2a",
    "name": "string",
    "publishedAt": "2026-10-25T17:54:38.179Z",
    "sandboxExpiresAt": "2026-10-25T17:54:38.179Z",
    "shortDescription": "string",
    "slug": "string",
    "subscriptionType": "SUBSCRIPTION_TYPE_PRO_PLAN",
    "tags": "string",
    "timezone": "string",
    "trialEndsAt": "2026-10-25T17:54:38.179Z",
    "unverifiedPauseAt": "2026-10-25T17:54:38.179Z",
    "updatedAt": "2026-10-25T17:54:38.179Z",
    "verifiedAt": "2026-10-25T17:54:38.179Z",
    "website": "string"
  },
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}
```

GET

`/v1/events`

Requires auth

## [#](#list-events)List events

Retrieves the workspace's event timeline, returning paginated JSON by default or CSV payloads for reporting exports. For workspaces on the free plan, events older than 2 weeks are restricted, and for light plan workspaces, events older than 3 months are restricted. Requires the \`analytics:read\` scope.

### [#](#list-events-parameters)Parameters

#### query parameters

linkId

string

query

Filter events to a specific link (optional, UUID) Optional

startDate

string (date-time)

query

Inclusive start timestamp for the query window (workspace timezone aware). Note: For free plan workspaces, this will be automatically adjusted to not go back more than 2 weeks. For light plan workspaces, this will be automatically adjusted to not go back more than 3 months.

endDate

string (date-time)

query

Inclusive end timestamp for the query window

responseFormat

string

query

Desired response format (defaults to RESPONSE\_FORMAT\_JSON; use RESPONSE\_FORMAT\_CSV for exports)

##### Allowed values

`RESPONSE_FORMAT_UNSPECIFIED`

Response format not specified

`RESPONSE_FORMAT_JSON`

Response format JSON

`RESPONSE_FORMAT_CSV`

Response format CSV

pageSize

integer (int64)

query

Maximum number of events to return (default: 100, max: 1000) Maximum number of events to return (default: 100, max: 1000)

pageToken

string

query

Cursor token to retrieve the next page of results Cursor token to retrieve the next page of results

include

array<string>

query

Optional list of relationships to include: visitor, device, link, workspace, journey Optional list of relationships to include: visitor, device, link, workspace, journey

visitorId

string

query

Filter events to a specific visitor (optional, UUID) Optional

cursor

string

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### [#](#list-events-response)Response

200

Everything worked as expected.

csv

object

ListEventsCsvResponse streams the export payload when ResponseFormat is set to RESPONSE\_FORMAT\_CSV.

json

object

ListEventsJsonResponse returns paginated event objects suitable for dashboards.

### [#](#list-events-error)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)

```bash
curl -X GET "https://api.linkbreakers.com/v1/events?linkId={linkId}&startDate={startDate}&endDate={endDate}&responseFormat={responseFormat}&pageSize={pageSize}&pageToken={pageToken}&include={include}&visitorId={visitorId}&cursor={cursor}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "csv": {
    "contentType": "string",
    "csvData": "string"
  },
  "json": {
    "events": [
      {
        "action": "ACTION_SCAN",
        "createdAt": "2026-10-25T17:54:38.173Z",
        "destination": "https://brand.example.com/checkout",
        "destinationAction": "EVENT_ACTION_CLIENT_REDIRECT",
        "device": {},
        "deviceId": "6f1b2e90-1234-4c8f-91e1-63cd927bf908",
        "entrypoint": "https://linkbreak.ing/4BnH-R19p",
        "httpMethod": "HTTP_METHOD_GET",
        "id": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
        "journey": {},
        "link": {},
        "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
        "scannedAt": "2026-10-25T17:54:38.174Z",
        "traces": [],
        "triggeredBy": "TRIGGERED_BY_VISITOR",
        "updatedAt": "2026-10-25T17:54:38.174Z",
        "visitType": "VISIT_TYPE_FIRST",
        "visitor": {},
        "visitorId": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
        "workspace": {},
        "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
      }
    ],
    "hasMore": false,
    "nextPageToken": "eyJwYWdlIjoxfQ==",
    "totalCount": 240
  }
}
```

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

GET

`/v1/events/{eventId}/traces`

Requires auth

## [#](#list-event-traces)List event traces

Retrieves all workflow step traces for an event, ordered by completion time. Useful for analyzing user engagement and workflow progression. Requires the \`analytics:read\` scope.

### [#](#list-event-traces-parameters)Parameters

#### path parameters

eventId

string

Required

path

Event ID to get traces for (UUID)

### [#](#list-event-traces-response)Response

200

Everything worked as expected.

traces

array<object>

List of event traces ordered by completed\_at

### [#](#list-event-traces-error)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)

```bash
curl -X GET "https://api.linkbreakers.com/v1/events/{eventId}/traces" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "traces": [
    {
      "completedAt": "2026-10-25T17:54:38.174Z",
      "createdAt": "2026-10-25T17:54:38.174Z",
      "eventId": "8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a",
      "id": "2a7b8c9d-1e2f-4a5b-9c8d-7e6f5a4b3c2d",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "savedAttributes": {},
      "stepAction": "contact_form",
      "stepData": {
        "contactCard": {},
        "countryCondition": {},
        "dayOfMonthCondition": {},
        "dayOfWeekCondition": {},
        "deviceActorCondition": {},
        "deviceBrandCondition": {},
        "deviceBrowserCondition": {},
        "devicePlatformCondition": {},
        "deviceTypeCondition": {},
        "entryAccess": {},
        "form": {},
        "identifyVisitor": {},
        "media": {},
        "multiLink": {},
        "password": {},
        "redirect": {},
        "socialLinks": {},
        "specificDateCondition": {},
        "timeOfDayCondition": {},
        "visitTypeCondition": {},
        "visitorDataCondition": {}
      },
      "stepKind": "INTERACTION",
      "updatedAt": "2026-10-25T17:54:38.174Z",
      "visitorId": "4da3e6a2-2d54-4b0f-9e17-4b6c2af7e9c5",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ]
}
```

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

---

Source: https://linkbreakers.com/help/api/events