Breadcrumbs

This section requires authentication.

Please refer to the Authentication section for more details.

Breadcrumb Object

Breadcrumbs are user navigation markers that track a user's journey through your application. They help you understand the sequence of actions a user took, making it easier to analyze user behavior and debug issues.

Breadcrumb Object Structure

Field	Type	Description
id	integer	Unique identifier for the breadcrumb
name	string	Name or description of the breadcrumb event
app_id	integer	Unique identifier of the app this breadcrumb belongs to
created_at	date	Timestamp when the breadcrumb was created (ISO8601)

---

Breadcrumb Occurrences

Each breadcrumb is associated with a specific consumer session through breadcrumb occurrences. This association allows you to track the exact sequence of actions a user took during a particular session, making it easier to:

• Trace user navigation paths within a session
• Identify where errors occurred in the user journey
• Debug issues by understanding the context of user actions
• Analyze behavior patterns across different sessions

---

Create Breadcrumb

This endpoint allows you to create a single breadcrumb event for a Consumer. Each breadcrumb represents a specific action or location in your application.

POST  /api/breadcrumbs

Headers

Header	Value
Authorization	Bearer {YOUR_AUTH_KEY}
Content-Type	application/json
Accept	application/json

Body Parameters

Required Parameters

Field	Type	Description	Example
name	string	The name of the breadcrumb event	Opened dashboard

Optional Parameters

Field	Type	Description	Example
created_at	string	Timestamp when the breadcrumb occurred (ISO8601). If no value is provided, the current server time will be used	2025-10-02T13:00:00Z

Example Request

JSON

{
    "name": "Opened dashboard",
    "created_at": "2025-10-02T13:00:00Z"
}

Example Response

JSON

{
    "id": 1,
    "name": "Opened dashboard",
    "app_id": 42,
    "created_at": "2025-10-02T13:00:00.000000Z"
}

---

Breadcrumb Batch

This endpoint allows you to save a batch of breadcrumbs for a Consumer. This is useful when you need to send multiple breadcrumb events at once, improving efficiency and reducing network requests.

POST  /api/breadcrumbs/batch

Headers

Header	Value
Authorization	Bearer {YOUR_AUTH_KEY}
Content-Type	application/json
Accept	application/json

Body Parameters

Required Parameters

Field	Type	Description	Example
breadcrumbs	array	Array of breadcrumb objects to be saved. Must contain between 1 and 100 items.	[{"name": "Opened dashboard", "created_at": "2025-10-02T13:00:00Z"}]
breadcrumbs[].name	string	The name of the breadcrumb event. Maximum 255 characters.	Opened dashboard

Optional Parameters

Field	Type	Description	Example
breadcrumbs[].created_at	string	Timestamp when the breadcrumb occurred (ISO8601). Must be before or equal to the current time. If not provided, the current server time will be used.	2025-10-02T13:00:00Z
breadcrumbs[].session_id	integer	Session ID to associate the breadcrumb with a specific session. Must be a valid existing session.	123

Example Request

JSON

{
    "breadcrumbs": [
        {
            "name": "Opened dashboard",
            "created_at": "2025-10-02T13:00:00Z",
            "session_id": 123
        },
        {
            "name": "Clicked settings button",
            "created_at": "2025-10-02T13:05:00Z",
            "session_id": 123
        },
        {
            "name": "Updated profile",
            "created_at": "2025-10-02T13:10:00Z",
            "session_id": 123
        }
    ]
}

Example Response

JSON

{
    "message": "Breadcrumbs queued for processing."
}

Batch Processing

Breadcrumb batch requests are processed asynchronously. The breadcrumbs are queued for processing and will be saved to the database in the background. This ensures fast response times even when sending large batches.

---