LeadBoxer
leadboxerLead generation platform that gives you real-time info about companies and people that visit your website. Turning anonymous web traffic into actionable data.
Acciones disponibles (9)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add or Update Lead TagsLEADBOXER_ADD_OR_UPDATE_LEAD_TAGSAcciónTool 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.
LEADBOXER_ADD_OR_UPDATE_LEAD_TAGSAcciónTool 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.
Parámetros de entrada
actionstringenumSpecifies the operation type. 'add' adds a tag without removing existing ones. 'remove' removes a specific tag. If omitted, overwrites all existing tags.
addremoveuserIdstringObligatorioThe LeadBoxer user ID of the visitor/lead. Can be obtained from the LeadBoxer cookie via ot_uid() function.
leadTagsstringObligatorioThe tag name/value to add, remove, or set for the lead.
datasetIdstringOptional dataset ID. If not provided, the site parameter from auth metadata will be used.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Custom Tracking DomainLEADBOXER_DELETE_CTDAcciónTool 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.
LEADBOXER_DELETE_CTDAcciónTool 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.
Parámetros de entrada
ctdstringObligatorioThe custom tracking domain value to delete (e.g., 'track.example.com').
emailstringObligatorioUser email address for authentication. Required to authorize the delete operation.
datasetIdstringObligatorioThe unique identifier for the dataset whose custom tracking domain should be deleted.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get EventsLEADBOXER_GET_EVENTSAcciónTool 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.
LEADBOXER_GET_EVENTSAcciónTool 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.
Parámetros de entrada
emailstringFilter events by email address. Use this to retrieve events for a specific email.
limitintegerMaximum number of events to return. Use this to limit the result set size.
userIdstringFilter events by user ID. Use this to retrieve all events associated with a specific user.
segmentIdstringFilter events by segment ID. Use this to retrieve events for users in a specific segment.
sessionIdstringFilter events by specific session ID. Use this to retrieve events for a particular user session.
smartlistIdstringFilter events by smartlist ID. Use this to retrieve events for users in a specific smartlist.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Lead Score FormulaLEADBOXER_GET_LEAD_SCORE_FORMULAAcciónTool 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).
LEADBOXER_GET_LEAD_SCORE_FORMULAAcciónTool 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).
Parámetros de entrada
emailstringOptional email parameter for additional filtering or context.
datasetIdstringObligatorioThe unique identifier for the dataset whose lead score formula you want to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SessionsLEADBOXER_GET_SESSIONSAcciónTool 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.
LEADBOXER_GET_SESSIONSAcciónTool 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.
Parámetros de entrada
emailstringOptional email address to filter sessions by email.
limitintegerMaximum number of sessions to return. Use this to limit the result set size.
leadIdstringObligatorioThe LeadBoxer user ID for which to retrieve sessions. This is a required parameter.
userIdstringOptional user identifier to filter sessions by user ID.
segmentIdstringOptional segment ID to filter sessions by segment membership.
smartlistIdstringOptional Smartlist ID to filter sessions by Smartlist membership.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Log Server-Side EventLEADBOXER_LOG_EVENTAcciónTool 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.
LEADBOXER_LOG_EVENTAcciónTool 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.
Parámetros de entrada
ipstringOverride the request IP address. Use this to provide the actual user IP if tracking from a server.
lcstringEvent location as a full URL. Represents the page or location where the event occurred.
tistringEvent title or name that will appear in the clickstream. Describes the action being tracked (e.g., 'User Signup', 'Purchase Complete').
tzstringTimezone metadata (e.g., 'America/New_York', 'Europe/London').
eidstringEvent ID. If not provided, it will be auto-generated by LeadBoxer.
refstringCurrent referrer URL. The page that referred the user to the current location.
sidstringSession ID. If not provided, a new session will be auto-created by LeadBoxer.
uidstringUser ID to update existing user records. Use this to associate the event with a known user.
emailstringUser email address for identification purposes.
proxybooleanWhen 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.
localestringUser locale metadata (e.g., 'en-US', 'fr-FR').
userIdstringPreferred user identifier. This is the recommended way to identify users.
browserstringBrowser metadata (e.g., 'Chrome', 'Firefox', 'Safari').
platformstringPlatform metadata (e.g., 'web', 'mobile', 'ios', 'android').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Custom Tracking DomainsLEADBOXER_MANAGEMENT_CTDAcciónTool 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.
LEADBOXER_MANAGEMENT_CTDAcciónTool 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.
Parámetros de entrada
emailstringObligatorioRequired email parameter for authentication.
datasetIdstringObligatorioThe unique identifier for the dataset whose custom tracking domains should be retrieved.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post Event DataLEADBOXER_POST_EVENTAcciónTool 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.
LEADBOXER_POST_EVENTAcciónTool 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.
Parámetros de entrada
sistringObligatorioDataset ID - Mandatory property that tells the engine which site/account the data is being inserted for.
tistringEvent title - Reserved property for displaying titles in LeadBoxer's UI. Describes the action being tracked.
sidstringSession ID - Identifies the user session. If not provided, a new session will be auto-created.
uidstringUser ID - Unique identifier for the user to associate the event with a known user.
namestringUser name for identification purposes.
pagestringPage URL being tracked - The location where the event occurred.
emailstringEmail address - User's email for identification purposes.
proxybooleanSet to true to prevent automatic detection and overwriting of user values like computer/browser, country/region/city data.
companystringCompany name associated with the user.
referrerstringReferrer URL - The page that referred the user to the current location.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Lead DetailLEADBOXER_VIEWS_LEAD_DETAILAcciónTool 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.
LEADBOXER_VIEWS_LEAD_DETAILAcciónTool 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.
Parámetros de entrada
emailstringEmail address parameter. Can be empty or contain an email address. By default, email addresses are masked in results.
leadIdstringObligatorioThe LeadBoxer user ID for the lead you want to retrieve details for. Can be obtained using the ot_uid() function.
noShortenEmailbooleanSet to true to disable email masking in the response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not