Jump to Content
Guides
API Reference
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
Ingestion Warnings
Search
All
Pages
Start typing to search…
JUMP TO
Getting Started
Welcome 👋
User Guides
Authentication
Reporting API
Overview
Agent
Single Agent
get
Multiple Agents
get
Metadata
Single Session
get
Multiple Sessions
get
Transcript
Single Transcript
get
Multiple Transcripts
get
Contact Center API
Overview
Integrations API
List the integrations
get
Create a new integration
post
Delete the integration
del
Get the integration
get
Patch an integration
patch
Update an integration
put
Conversations API
End Chat
post
Retrieve Conversation History
get
Send Message
put
Retrieve Metadata
get
Update Metadata
patch
Send Typing Status
post
Webhooks
Sample App
Engagement API
Overview
Endpoints
Create User
post
Start Engagement
post
Send Message
post
Keep Engagement Alive
post
Typing Indicator
post
Generate Snapshot
post
End Engagement
post
WebSocket
Webhooks
Analytics API
Overview
Datasets
/api/datasets/
get
/api/datasets/{id}/
get
Actions
/api/datasets/{dataset_id}/actions/
get
/api/datasets/{dataset_id}/actions/{id}/
get
Activity Log
Annotations
/api/datasets/{dataset_id}/annotations/
get
/api/datasets/{dataset_id}/annotations/{id}/
get
App Metrics
Batch Exports
Cohorts
/api/datasets/{dataset_id}/cohorts/
get
/api/datasets/{dataset_id}/cohorts/{id}/
get
/api/datasets/{dataset_id}/cohorts/{id}/persons/
get
Dashboard Templates
Dashboards
/api/datasets/{dataset_id}/dashboards/
get
/api/datasets/{dataset_id}/dashboards/{id}/
get
Data Management
Event Definitions
/api/datasets/{dataset_id}/event_definitions/
get
/api/datasets/{dataset_id}/event_definitions/{id}/
get
Events
/api/datasets/{dataset_id}/events/
get
/api/datasets/{dataset_id}/events/{id}/
get
Exports
Ingestion Warnings
Insights
/api/datasets/{dataset_id}/insights/
get
/api/datasets/{dataset_id}/insights/{id}/
get
/api/datasets/{dataset_id}/insights/funnel/
get
/api/datasets/{dataset_id}/insights/path/
get
/api/datasets/{dataset_id}/insights/retention/
get
/api/datasets/{dataset_id}/insights/trend/
get
Funnel
Trend
Integrations
KPI Rows
KPIs
/api/datasets/{dataset_id}/kpis/
get
/api/datasets/{dataset_id}/kpis/{id}/
get
Persons
/api/datasets/{dataset_id}/persons/
get
/api/datasets/{dataset_id}/persons/{id}/
get
Property Definitions
/api/datasets/{dataset_id}/property_definitions/
get
/api/datasets/{dataset_id}/property_definitions/{id}/
get
Query
Session Recordings
Warehouse Table
Change
Is Generating Demo Data
Reset Token
Organization
/api/organization/
get
/api/organization/{id}/
get
Projects
/api/projects/
get
/api/projects/{id}/
get
JS API (Pypestream SDK)
Overview
Powered by
Ingestion Warnings
