Leads

Retrieve Lead Sessions

Returns all sessions associated with a specific lead ID. Results can be filtered by segment and time range.

get/v1/leads/sessions

Request

  • Base URL: https://api.leadboxer.com
  • URL: https://api.leadboxer.com/v1/leads/sessions
  • Auth: API key in header x-api-key

Query parameters

leadIdstring required

Display data for the given leadId. LeadId is a unique identifier of each lead.

limitinteger required

The minimum number of records to be displayed in the output.<br/>Range : 1 - 10000

sitestring required

Dataset ID (site) for which sessions are retrieved

emailstring

Email associated with the account

userIdinteger

UserId associated with email

segmentIdinteger

Filter results using a segment filters

minTimeinteger

Filter sessions by minimum session duration.

nextTokenstring

Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.

Response

OK

dataobject[]
metaDataobject

Changes

No recorded changes to this operation across all 1 revision of this API.