Get All Lead Details

This API used to Get All Lead Details of the specified event.
To call this API, user have to pass path param with API URL like eventUrl, id and query params like searchString, page, size and authentication key to authenticate user.

Response

Here is the description of response attributes, which returns to the form of JSON.

Attributes

Description

data

This field returns a list of all lead details. list contains :
leadId : This field returns lead id.
retrieverUserId : This field returns retriever user id.
createdOn : This field returns the date on which lead was created.
scan : This field returns boolean value for the scan.
rating : This field returns rating of lead.
note : This field returns note.
owner : This field returns lead owner.
ownerStaffId : This field returns lead owner staff id.
leadData : It returns Ticket holder details following :
eventTicketId : This field returns event ticket id.
holderFirstName : This field returns firstname of ticket holder.
holderLastName : This field returns lastname of ticket holder.
holderEmail : This field returns email of ticket holder.
holderCountryCode : This field returns country code of ticket holder.
holderPhoneNumber : This field returns phone number of ticket holder.
title : This field returns title of ticket holder.
company : This field returns company name of ticket holder.
source :
userActivity : It returns Exhibitors activity details like :
firstName : This field returns lead firstname
lastName : This field returns lead lastname
createdAt : This field returns when leas was created.
visited : This field returns lead visit.
documentName : This field returns document names which lead has downloaded.
documentLink : This field returns document links which lead has visited.
attendeeId : This field returns attendee id.
location : This field returns location.
trackingData : This field returns list of Tracking data as following :
eventId : This field returns event id.
userId : This field returns user id.
expoId : This field returns exhibitor id.
sessionId : This field returns session id.
area : This field returns area in gemification
gameType : This field returns game type in gamification.
timeInBooth : This field returns the time lead has spent in booth.
documentDownloads : This field returns document names which lead has downloaded.
linkClicked : This field returns document links which lead has visited.
videoPlayed : This field returns boolean value for whether lead has played video in company profile page.
chat : This field returns boolean value for whether lead has chat in booth.
date : This field returns the date when lead visited booth.
totalPoints : This field returns total points of lead in gamification.
totalVisit : This field returns total visits of lead to booth.
challengeId : This field returns challenge id which lead has visited.
joinMeeting : This field returns list of meetings lead has joined.
productView : This field returns list of products lead has viewed.
videoDuration : This field returns the time duration in which video is played by lead.
ticketTypeIds : This field returns ticket type ids of lead .
matchUsers : This field returns the list of matched users of lead.
connectedUsers : This field returns the list of connected users of lead.
visitToTheBooth : This field returns boolean value for whether lead has visited the booth.
requestMeeting : This field returns boolean value for whether lead has requested a demo meeting.
videoPointsSet : This field returns boolean value for whether video point is set.
recordingVideoPointsSet : This field returns boolean value for whether recording video point is set.
timeInBoothPointsSet : This field returns boolean value for whether time in booth is set.
ticketPurchase : This field returns boolean value for whether lead has purchased ticket.
eventCheckIn : This field returns boolean value for whether lead has checked in event.
matchPoints : This field returns the match points of lead in gamification.
connectionPoints : This field returns the connection points of lead.
additionalInteractions : This field returns additional interactions with leads.
acceptDirectMessages : This field returns boolean value for whether to accept direct messages from leads.

error

Error display if getting any error while getting records.

recordsFiltered

Filter records to getting all lead details.

recordsTotal

Total records of leads.

Error Code

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

200

Returns all lead details

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

40600013

Cant create url

4040200

Event not Found

4030201

Not Event Host

Language
Authentication
Header
Click Try It! to start a request and see the response here!