Jump to Content
Guides
API Reference
Log In
API Reference
Log In
Guides
API Reference
Overview
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
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
JS API (Pypestream SDK)
Overview
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
Annotations
/api/datasets/{dataset_id}/annotations/
get
/api/datasets/{dataset_id}/annotations/{id}/
get
Cohorts
/api/datasets/{dataset_id}/cohorts/
get
/api/datasets/{dataset_id}/cohorts/{id}/
get
/api/datasets/{dataset_id}/cohorts/{id}/persons/
get
Dashboards
/api/datasets/{dataset_id}/dashboards/
get
/api/datasets/{dataset_id}/dashboards/{id}/
get
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
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
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
Organization
/api/organization/
get
/api/organization/{id}/
get
Projects
/api/projects/
get
/api/projects/{id}/
get
Batch Exports
/api/datasets/{dataset_id}/batch_exports/
get
/api/datasets/{dataset_id}/batch_exports/
post
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/
get
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
get
/api/datasets/{dataset_id}/batch_exports/{id}/
get
/api/datasets/{dataset_id}/batch_exports/{id}/
put
/api/datasets/{dataset_id}/batch_exports/{id}/
patch
/api/datasets/{dataset_id}/batch_exports/{id}/
del
/api/datasets/{dataset_id}/batch_exports/{id}/backfill/
post
/api/datasets/{dataset_id}/batch_exports/{id}/pause/
post
/api/datasets/{dataset_id}/batch_exports/{id}/unpause/
post
Powered by
Overview
Ask AI
Engagement API | Version: 1
