API Builder
Access AdaptiveCX data through server-side APIs for custom integrations, data export, and analysis.
What API Builder does
The API Builder provides programmatic access to your AdaptiveCX data:
Raw Data: Export detailed visitor and session data
Aggregated Data: Export summarized metrics for analytics
Custom queries: Filter and group data for specific needs
Real-time access: Retrieve data on demand via API
Raw Data endpoint
Export detailed visitor and session data for granular analysis.
Parameters
Start Date: Beginning of date range (required)
End Date: End of date range (required)
Group By: Session ID, Visitor ID, or custom groupings
Page Number: For paginated results
Data to Show: Specific attributes and events to include
Example request
Aggregated Data endpoint
Export summarized metrics for analytics and reporting.
API Types
Daily Sessions: Session counts by day
Unique Visitors: Visitor counts by day
Event Counts: Event occurrence summaries
Conversion Metrics: Goal completion data
Parameters
Start Date: Beginning of date range (required)
End Date: End of date range (required)
Timezone: Your timezone for accurate daily grouping
Data Breakdown by: Domain or Subdomain
Example request
Authentication
The API Builder generates the request URL with your credentials automatically included:
The clientTag and token parameters are pre-populated in the API Request section. Copy this URL to use in your applications.
Keep your API token secure. Never expose it in client-side code, public repositories, or logs.
Last updated
Was this helpful?