# LeadBoxer

Lead generation platform that gives you real-time info about companies and people that visit your website. Turning anonymous web traffic into actionable data.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `LEADBOXER`
- **Version:** 00000000_00

## Tools

### Add or Update Lead Tags

**Slug:** `LEADBOXER_ADD_OR_UPDATE_LEAD_TAGS`

Tool to add or update lead tags in LeadBoxer. Use when you need to manage lead tags by adding new tags, removing specific tags, or overwriting all existing tags for a specified user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string ("add" | "remove") | No | Specifies the operation type. 'add' adds a tag without removing existing ones. 'remove' removes a specific tag. If omitted, overwrites all existing tags. |
| `userId` | string | Yes | The LeadBoxer user ID of the visitor/lead. Can be obtained from the LeadBoxer cookie via ot_uid() function. |
| `leadTags` | string | Yes | The tag name/value to add, remove, or set for the lead. |
| `datasetId` | string | No | Optional dataset ID. If not provided, the site parameter from auth metadata will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Tracking Domain

**Slug:** `LEADBOXER_DELETE_CTD`

Tool to delete a custom tracking domain entry for a dataset. Use when you need to remove a specific custom tracking domain (CTD) associated with a dataset in LeadBoxer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ctd` | string | Yes | The custom tracking domain value to delete (e.g., 'track.example.com'). |
| `email` | string | Yes | User email address for authentication. Required to authorize the delete operation. |
| `datasetId` | string | Yes | The unique identifier for the dataset whose custom tracking domain should be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Events

**Slug:** `LEADBOXER_GET_EVENTS`

Tool to fetch events for specified sessions from LeadBoxer. Use when you need to retrieve behavioral data including pageviews, clicks, form submissions, email interactions, and custom events. Events can be filtered by session ID, email, user ID, or segment/smartlist IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Filter events by email address. Use this to retrieve events for a specific email. |
| `limit` | integer | No | Maximum number of events to return. Use this to limit the result set size. |
| `userId` | string | No | Filter events by user ID. Use this to retrieve all events associated with a specific user. |
| `segmentId` | string | No | Filter events by segment ID. Use this to retrieve events for users in a specific segment. |
| `sessionId` | string | No | Filter events by specific session ID. Use this to retrieve events for a particular user session. |
| `smartlistId` | string | No | Filter events by smartlist ID. Use this to retrieve events for users in a specific smartlist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Score Formula

**Slug:** `LEADBOXER_GET_LEAD_SCORE_FORMULA`

Tool to fetch the lead score formula for a specific dataset. Use when you need to understand how lead scores are calculated for records in a dataset. The formula defines scoring based on criteria types: Range (number ranges), Match (exact values), Exists (presence of values), and Boost (event-based scoring).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Optional email parameter for additional filtering or context. |
| `datasetId` | string | Yes | The unique identifier for the dataset whose lead score formula you want to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sessions

**Slug:** `LEADBOXER_GET_SESSIONS`

Tool to fetch sessions for a specified lead ID from LeadBoxer. Use when you need to retrieve session data for a user, with optional filtering by email, user ID, Smartlist ID, or segment ID. A session represents a single visit to the site, and users can have multiple sessions over time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Optional email address to filter sessions by email. |
| `limit` | integer | No | Maximum number of sessions to return. Use this to limit the result set size. |
| `leadId` | string | Yes | The LeadBoxer user ID for which to retrieve sessions. This is a required parameter. |
| `userId` | string | No | Optional user identifier to filter sessions by user ID. |
| `segmentId` | string | No | Optional segment ID to filter sessions by segment membership. |
| `smartlistId` | string | No | Optional Smartlist ID to filter sessions by Smartlist membership. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log Server-Side Event

**Slug:** `LEADBOXER_LOG_EVENT`

Tool to track server-side events in LeadBoxer. Use when tracking backend events, page views, or custom activities from your server. This endpoint supports tracking user interactions, conversions, and other activities that occur on the server-side.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ip` | string | No | Override the request IP address. Use this to provide the actual user IP if tracking from a server. |
| `lc` | string | No | Event location as a full URL. Represents the page or location where the event occurred. |
| `ti` | string | No | Event title or name that will appear in the clickstream. Describes the action being tracked (e.g., 'User Signup', 'Purchase Complete'). |
| `tz` | string | No | Timezone metadata (e.g., 'America/New_York', 'Europe/London'). |
| `eid` | string | No | Event ID. If not provided, it will be auto-generated by LeadBoxer. |
| `ref` | string | No | Current referrer URL. The page that referred the user to the current location. |
| `sid` | string | No | Session ID. If not provided, a new session will be auto-created by LeadBoxer. |
| `uid` | string | No | User ID to update existing user records. Use this to associate the event with a known user. |
| `email` | string | No | User email address for identification purposes. |
| `proxy` | boolean | No | When set to true, prevents automatic geo-location and user-agent enrichment. Use when tracking events from a proxy or when you want to avoid automatic enrichment. |
| `locale` | string | No | User locale metadata (e.g., 'en-US', 'fr-FR'). |
| `userId` | string | No | Preferred user identifier. This is the recommended way to identify users. |
| `browser` | string | No | Browser metadata (e.g., 'Chrome', 'Firefox', 'Safari'). |
| `platform` | string | No | Platform metadata (e.g., 'web', 'mobile', 'ios', 'android'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Tracking Domains

**Slug:** `LEADBOXER_MANAGEMENT_CTD`

Tool to fetch custom tracking domain entries for a dataset. Use when you need to retrieve all custom tracking domains that are created or in progress for a specific datasetId.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Required email parameter for authentication. |
| `datasetId` | string | Yes | The unique identifier for the dataset whose custom tracking domains should be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Post Event Data

**Slug:** `LEADBOXER_POST_EVENT`

Tool to send event data for tracking user activities via POST request. Use when tracking events by sending data in the request body with application/x-www-form-urlencoded format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `si` | string | Yes | Dataset ID - Mandatory property that tells the engine which site/account the data is being inserted for. |
| `ti` | string | No | Event title - Reserved property for displaying titles in LeadBoxer's UI. Describes the action being tracked. |
| `sid` | string | No | Session ID - Identifies the user session. If not provided, a new session will be auto-created. |
| `uid` | string | No | User ID - Unique identifier for the user to associate the event with a known user. |
| `name` | string | No | User name for identification purposes. |
| `page` | string | No | Page URL being tracked - The location where the event occurred. |
| `email` | string | No | Email address - User's email for identification purposes. |
| `proxy` | boolean | No | Set to true to prevent automatic detection and overwriting of user values like computer/browser, country/region/city data. |
| `company` | string | No | Company name associated with the user. |
| `referrer` | string | No | Referrer URL - The page that referred the user to the current location. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Lead Detail

**Slug:** `LEADBOXER_VIEWS_LEAD_DETAIL`

Tool to fetch detailed information about a lead based on filters. Use when you need comprehensive lead data for a specific lead ID. The default view type is B2B. Note: On initial pageview, there may be a few seconds overhead before data is populated; consider implementing a 3-second delay after lead creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address parameter. Can be empty or contain an email address. By default, email addresses are masked in results. |
| `leadId` | string | Yes | The LeadBoxer user ID for the lead you want to retrieve details for. Can be obtained using the ot_uid() function. |
| `noShortenEmail` | boolean | No | Set to true to disable email masking in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |