Skip to main content
LeadBoxer logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: LEADBOXER
  • Version: 20260615_00

Tools

Slug: LEADBOXER_ADD_OR_UPDATE_LEAD_TAGSTool 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

string ("add" | "remove")
Specifies the operation type. ‘add’ adds a tag without removing existing ones. ‘remove’ removes a specific tag. If omitted, overwrites all existing tags.
string
required
The LeadBoxer user ID of the visitor/lead. Can be obtained from the LeadBoxer cookie via ot_uid() function.
string
required
The tag name/value to add, remove, or set for the lead.
string
Optional dataset ID. If not provided, the site parameter from auth metadata will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_DELETE_CTDTool 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

string
required
The custom tracking domain value to delete (e.g., ‘track.example.com’).
string
required
User email address for authentication. Required to authorize the delete operation.
string
required
The unique identifier for the dataset whose custom tracking domain should be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_GET_EVENTSTool 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

string
Filter events by email address. Use this to retrieve events for a specific email.
integer
Maximum number of events to return. Use this to limit the result set size.
string
Filter events by user ID. Use this to retrieve all events associated with a specific user.
string
Filter events by segment ID. Use this to retrieve events for users in a specific segment.
string
Filter events by specific session ID. Use this to retrieve events for a particular user session.
string
Filter events by smartlist ID. Use this to retrieve events for users in a specific smartlist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_GET_LEAD_SCORE_FORMULATool 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

string
Optional email parameter for additional filtering or context.
string
required
The unique identifier for the dataset whose lead score formula you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_GET_SESSIONSTool 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

string
Optional email address to filter sessions by email.
integer
Maximum number of sessions to return. Use this to limit the result set size.
string
required
The LeadBoxer user ID for which to retrieve sessions. This is a required parameter.
string
Optional user identifier to filter sessions by user ID.
string
Optional segment ID to filter sessions by segment membership.
string
Optional Smartlist ID to filter sessions by Smartlist membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_LOG_EVENTTool 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

string
Override the request IP address. Use this to provide the actual user IP if tracking from a server.
string
Event location as a full URL. Represents the page or location where the event occurred.
string
Event title or name that will appear in the clickstream. Describes the action being tracked (e.g., ‘User Signup’, ‘Purchase Complete’).
string
Timezone metadata (e.g., ‘America/New_York’, ‘Europe/London’).
string
Event ID. If not provided, it will be auto-generated by LeadBoxer.
string
Current referrer URL. The page that referred the user to the current location.
string
Session ID. If not provided, a new session will be auto-created by LeadBoxer.
string
User ID to update existing user records. Use this to associate the event with a known user.
string
User email address for identification purposes.
boolean
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.
string
User locale metadata (e.g., ‘en-US’, ‘fr-FR’).
string
Preferred user identifier. This is the recommended way to identify users.
string
Browser metadata (e.g., ‘Chrome’, ‘Firefox’, ‘Safari’).
string
Platform metadata (e.g., ‘web’, ‘mobile’, ‘ios’, ‘android’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_MANAGEMENT_CTDTool 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

string
required
Required email parameter for authentication.
string
required
The unique identifier for the dataset whose custom tracking domains should be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_POST_EVENTTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LEADBOXER_VIEWS_LEAD_DETAILTool 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

string
Email address parameter. Can be empty or contain an email address. By default, email addresses are masked in results.
string
required
The LeadBoxer user ID for the lead you want to retrieve details for. Can be obtained using the ot_uid() function.
boolean
Set to true to disable email masking in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not