Get User Journey Analytics

API Documentation (v5)

Method	Endpoint	Description
`POST`	/v5/oauth/token	Generate an OAuth access token
`GET`	/v5/forms/attendeeFields	Retrieve attendee form fields
`POST`	/v5/users/attendees	Create or update an attendee
`GET`	/v5/users/attendees	Retrieve all attendees
`POST`	/v5/users/attendees/{attendeeId}/resume	Upload an attendee's resume
`DELETE`	/v5/users/attendees/{attendeeId}/delete	Remove an attendee
`POST`	/v5/sessions/sessionTracks	Create or update a session track
`GET`	/v5/sessions/sessionTracks	Retrieve all session tracks
`DELETE`	/v5/sessions/sessionTracks/{id}	Delete a session track
`POST`	/v5/sessions	Create or update a session
`GET`	/v5/sessions	Retrieve all sessions
`DELETE`	/v5/sessions/{id}	Delete a session
`POST`	/v5/sessions/sessionHandouts	Upload or update a session handout
`GET`	/v5/sessions/sessionHandouts	Retrieve all session handouts
`DELETE`	/v5/sessions/sessionHandouts/{id}	Remove a session handout
`GET`	/v5/forms/speakerFields	Retrieve speaker form fields
`POST`	/v5/users/speakers	Create or update a speaker profile
`GET`	/v5/users/speakers	Retrieve all speakers
`DELETE`	/v5/users/speakers	Remove a speaker profile
`GET`	/v5/event/languages	Retrieve available event languages
`GET`	/v5/event/getEventDetails	Get detailed event information
`GET`	/v5/reports/qrScanAnalytics	Retrieve QR scan analytics
`GET`	/v5/reports/userJourneyAnalytics	Retrieve user journey analytics
`POST`	/v5/booths	Create or update a booth
`GET`	/v5/booths	Retrieve all booths
`DELETE`	/v5/booths	Remove a booth and optionally its representatives
`GET`	/v5/forms/boothRepFields	Retrieve booth representative form fields
`POST`	/v5/users/boothReps	Create or update a booth representative
`GET`	/v5/users/boothReps	Retrieve all booth representatives
`DELETE`	/v5/users/boothReps/{boothRepId}	Remove a booth representative
`POST`	/v5/floors	Create or update a floor
`GET`	/v5/floors	Retrieve all floors
`DELETE`	/v5/floors/{floorId}	Remove a floor and all its associated booths
`POST`	/v5/booths/documents	Create or update a booth document
`GET`	/v5/booths/documents	Retrieve all booth documents
`DELETE`	/v5/booths/documents/{documentId}	Remove a booth document
`POST`	/v5/booths/videos	Create or update a booth video
`GET`	/v5/booths/videos	Retrieve all booth videos
`DELETE`	/v5/booths/videos/{videoId}	Remove a booth video

Download OpenAPI description

Download Postman

Download OpenApi

Overview

Integrations

integrations@vfairs.com

Servers

https://api.vfairs.com/rest/

https://api.vfairs.ca/rest/

https://api-eu.vfairs.com/rest/

https://api-uk.vfairs.com/rest/

KSA

https://api-ksa.vfairs.com/rest/

OAuth Access Token

Endpoints for obtaining and managing OAuth access tokens for API authentication.

Operations

Attendees

Manages attendee data for events, including registration, profile updates, resume uploads, and form field configuration. These endpoints enable comprehensive attendee lifecycle management from registration through event participation.

Operations

Session Tracks

Manages session tracks for multi-language events. Session tracks organize sessions by categories, dates, or themes and support localization through language-specific configurations.

Operations

Sessions

Manages event sessions including creation, updates, retrieval, and deletion. Sessions can be linked to tracks and speakers, support multi-language configurations, and offer various session types for different event formats.

Operations

Session Handouts

Endpoints for managing session handouts - documents associated with sessions that attendees can view or download.

Operations

Speakers

Endpoints for managing speaker profiles and their session associations. Speakers can be created, updated, retrieved, and deleted, with support for dynamic form configurations and session linking.

Operations

Booths

Manages virtual exhibition booths where exhibitors showcase products, services, and company information. Booths are organized within floors and can include representatives, videos, documents, and interactive features with customizable layouts and access permissions.

Operations

Booth Documents

Manage booth documents including PDFs, Word documents, Excel spreadsheets, and PowerPoint presentations. Exhibitors can share these documents with booth visitors, and documents can be automatically added to visitor briefcases.

Operations

Booth Videos

Manages booth videos for events. Videos can showcase products, provide demonstrations, or share company information. Supported formats include MP4, MOV, WMV, AVI, and FLV.

Operations

Floors

Manages virtual floors within events. Floors organize booths in a virtual event space and can be customized with different layouts and themes.

Operations

Event

This section provides endpoints to retrieve event metadata, including available languages for multi-language configuration and detailed event information. These endpoints are essential for localizing content such as sessions and tracks and integrating event-specific settings to ensure a seamless and customized event experience.

Operations

Reports

Endpoints for retrieving event analytics and reporting data including QR scan analytics and user journey reports.

Operations

Get QR Scan Analytics

Request

Retrieves paginated QR scan analytics data showing who scanned whom and when during the event.

Security

default

Query

registration_fieldsstring

Comma-separated list of registration field IDs to include in the report. Used to filter which user registration data fields are returned.

Example: registration_fields=1,2,3

user_typestring

Filter results by user type. Must be one of: ALL, Attendee, Admin, Event Owner, Booth Admin.

Example: user_type=Attendee

start_datestring

Start date for filtering scan records. Must be in Y-m-d format.

Example: start_date=2024-01-01

end_datestring

End date for filtering scan records. Must be in Y-m-d format.

Example: end_date=2024-12-31

scanned_user_idinteger

Filter by the ID of the user whose QR code was scanned. Use this to see all scans of a specific user.

Example: scanned_user_id=1234910710

scanned_by_user_idinteger

Filter by the ID of the user who performed the scan. Use this to see all scans performed by a specific user.

Example: scanned_by_user_id=1234910702

sort_by_scanned_atinteger

Sort order for scan timestamp. Use 0 for ascending (oldest first) or 1 for descending (newest first).

Example: sort_by_scanned_at=1

pageinteger

Page number for pagination. Starts from 1.

Example: page=1

limitinteger

Number of records to return per page. Maximum recommended value is 100.

Example: limit=10

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/reports/qrScanAnalytics?end_date=2024-12-31&limit=10&page=1&registration_fields=1%2C2%2C3&scanned_by_user_id=1234910702&scanned_user_id=1234910710&sort_by_scanned_at=1&start_date=2024-01-01&user_type=Attendee' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "QR Scan Analytics Report retrieved successfully"

qr_scan_analyticsArray of objects

Example: [{"event_id":1234,"event_url":"myevent.vfairs.com","scan_id":1121,"scanned_time":"01:52 PM","scanned_qr_url":"","scanned_user_id":1234910710,"scanned_first_name":"Driscoll","scanned_last_name":"Meyers","scanned_email":"xyz@vfairs.com","scanned_user_notes":null,"scanned_user_type":"Visitor","scanned_by_user_id":1234910702,"scanned_by_first_name":"Ralph","scanned_by_last_name":"Paul","scanned_by_email":"xya1@vfairs.com","scanned_by_user_notes":"","scanned_by_user_type":"Visitor"}]

metaobject

Example: {"current_page":1,"from":1,"last_page":9276,"path":"http://api.vfairs.com/rest/v5/reports/qrScanAnalytics","per_page":1,"to":1,"total":9276}

Response

application/json

{
  "status": true,
  "message": "QR Scan Analytics Report retrieved successfully",
  "qr_scan_analytics": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 9276,
    "path": "http://api.vfairs.com/rest/v5/reports/qrScanAnalytics",
    "per_page": 1,
    "to": 1,
    "total": 9276
  }
}

Get User Journey Analytics

Request

Retrieves detailed user journey analytics showing user interactions, page visits, and engagement patterns throughout the event.

Security

default

Query

pageinteger

Page number for pagination results.

Example: page=1

limitinteger

Number of records to return per page.

Example: limit=50

user_idinteger

Unique identifier of a specific user to track. Must correspond to an existing event user. Required if email is not provided.

Example: user_id=12345

emailstring

Email address of the user to track. Must correspond to an existing event user. Required if user_id is not provided.

Example: email=john.doe@example.com

start_datestring

Start date for filtering user journey data. Format: YYYY-MM-DD.

Example: start_date=2024-01-01

end_datestring

End date for filtering user journey data. Format: YYYY-MM-DD.

Example: end_date=2024-01-31

show_only_liveinteger

Filter to show only live activities. Use 1 to show only live activities, 0 to show all activities.

Enum01

Example: show_only_live=0

activity_typesstring

Comma-separated list of activity types to filter by. Available types: NAVIGATION, CHAT, SCAVENGER_HUNT, WEBINAR, VIDEO, BOOTH_VISIT, BOOTH_LINK_CLICK, DOCUMENT, SWAG_BAG, LOGIN, CMS_PAGE, BOOTH_BANNER. Use "ALL" to include all activity types.

Example: activity_types=LOGIN,WEBINAR,BOOTH_VISIT

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/reports/userJourneyAnalytics?activity_types=LOGIN%2CWEBINAR%2CBOOTH_VISIT&email=john.doe%40example.com&end_date=2024-01-31&limit=50&page=1&show_only_live=0&start_date=2024-01-01&user_id=12345' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "User journey analytics fetched successfully."

user_journey_analyticsArray of objects

Example: [{"user_id":12345,"user_name":"John Doe","user_email":"john.doe@example.com","journey_events":[{"event_type":"login","timestamp":"2024-01-15 09:30:00","location":"lobby"},{"event_type":"session_join","timestamp":"2024-01-15 10:00:00","location":"auditorium_1","session_name":"Opening Keynote"}],"total_engagement_time":3600,"pages_visited":15}]

Response

application/json

{
  "status": true,
  "message": "User journey analytics fetched successfully.",
  "user_journey_analytics": [
    { … }
  ]
}

API Documentation (v5)

OAuth Access Token

Attendees

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Documents

Booth Videos

Floors

Event

Reports

Get QR Scan Analytics

Request

Responses

Was this helpful?

Get User Journey Analytics

Request

Responses

Was this helpful?