Jump to Content
Guides
API Reference
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
/api/datasets/{dataset_id}/kpis/{id}/
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
PostHog API
Datasets
/api/datasets/
get
/api/datasets/{id}/
get
/api/datasets/{id}/
put
/api/datasets/{id}/
patch
Actions
/api/datasets/{dataset_id}/actions/
get
/api/datasets/{dataset_id}/actions/
post
/api/datasets/{dataset_id}/actions/{id}/
get
/api/datasets/{dataset_id}/actions/{id}/
put
/api/datasets/{dataset_id}/actions/{id}/
patch
/api/datasets/{dataset_id}/actions/{id}/
del
/api/datasets/{dataset_id}/actions/{id}/count/
get
/api/datasets/{dataset_id}/actions/people/
get
Activity Log
/api/datasets/{dataset_id}/activity_log/bookmark_activity_notification/
post
/api/datasets/{dataset_id}/activity_log/important_changes/
get
Annotations
/api/datasets/{dataset_id}/annotations/
get
/api/datasets/{dataset_id}/annotations/
post
/api/datasets/{dataset_id}/annotations/{id}/
get
/api/datasets/{dataset_id}/annotations/{id}/
put
/api/datasets/{dataset_id}/annotations/{id}/
patch
/api/datasets/{dataset_id}/annotations/{id}/
del
App Metrics
/api/datasets/{dataset_id}/app_metrics/{parent_lookup_plugin_config_id}/historical_exports/
get
/api/datasets/{dataset_id}/app_metrics/{parent_lookup_plugin_config_id}/historical_exports/{id}/
get
/api/datasets/{dataset_id}/app_metrics/{id}/
get
/api/datasets/{dataset_id}/app_metrics/{id}/error_details/
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/
post
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
get
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
put
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
patch
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/
del
/api/datasets/{dataset_id}/batch_exports/{parent_lookup_batch_export_id}/runs/{id}/reset/
post
/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
Cohorts
/api/datasets/{dataset_id}/cohorts/
get
/api/datasets/{dataset_id}/cohorts/
post
/api/datasets/{dataset_id}/cohorts/{id}/
get
/api/datasets/{dataset_id}/cohorts/{id}/
put
/api/datasets/{dataset_id}/cohorts/{id}/
patch
/api/datasets/{dataset_id}/cohorts/{id}/
del
/api/datasets/{dataset_id}/cohorts/{id}/duplicate_as_static_cohort/
get
/api/datasets/{dataset_id}/cohorts/{id}/persons/
get
Dashboard Templates
/api/datasets/{dataset_id}/dashboard_templates/
get
/api/datasets/{dataset_id}/dashboard_templates/
post
/api/datasets/{dataset_id}/dashboard_templates/{id}/
get
/api/datasets/{dataset_id}/dashboard_templates/{id}/
put
/api/datasets/{dataset_id}/dashboard_templates/{id}/
patch
/api/datasets/{dataset_id}/dashboard_templates/{id}/
del
/api/datasets/{dataset_id}/dashboard_templates/json_schema/
get
Dashboards
/api/datasets/{dataset_id}/dashboards/
get
/api/datasets/{dataset_id}/dashboards/
post
/api/datasets/{dataset_id}/dashboards/{id}/
get
/api/datasets/{dataset_id}/dashboards/{id}/
put
/api/datasets/{dataset_id}/dashboards/{id}/
patch
/api/datasets/{dataset_id}/dashboards/{id}/
del
/api/datasets/{dataset_id}/dashboards/{id}/move_tile/
patch
/api/datasets/{dataset_id}/dashboards/create_from_template_json/
post
Data Management
/api/datasets/{dataset_id}/data_management/activity/
get
Early Access Features
/api/datasets/{dataset_id}/early_access_feature/
get
/api/datasets/{dataset_id}/early_access_feature/
post
/api/datasets/{dataset_id}/early_access_feature/{id}/
get
/api/datasets/{dataset_id}/early_access_feature/{id}/
put
/api/datasets/{dataset_id}/early_access_feature/{id}/
patch
/api/datasets/{dataset_id}/early_access_feature/{id}/
del
Event Definitions
/api/datasets/{dataset_id}/event_definitions/
get
/api/datasets/{dataset_id}/event_definitions/{id}/
get
/api/datasets/{dataset_id}/event_definitions/{id}/
put
/api/datasets/{dataset_id}/event_definitions/{id}/
patch
/api/datasets/{dataset_id}/event_definitions/{id}/
del
Events
/api/datasets/{dataset_id}/events/
get
/api/datasets/{dataset_id}/events/{id}/
get
/api/datasets/{dataset_id}/events/values/
get
Exports
/api/datasets/{dataset_id}/exports/
post
/api/datasets/{dataset_id}/exports/{id}/
get
/api/datasets/{dataset_id}/exports/{id}/content/
get
Feature Flags
/api/datasets/{dataset_id}/feature_flags/
get
/api/datasets/{dataset_id}/feature_flags/
post
/api/datasets/{dataset_id}/feature_flags/{id}/
get
/api/datasets/{dataset_id}/feature_flags/{id}/
put
/api/datasets/{dataset_id}/feature_flags/{id}/
patch
/api/datasets/{dataset_id}/feature_flags/{id}/
del
/api/datasets/{dataset_id}/feature_flags/{id}/activity/
get
/api/datasets/{dataset_id}/feature_flags/{id}/dashboard/
post
/api/datasets/{dataset_id}/feature_flags/activity/
get
/api/datasets/{dataset_id}/feature_flags/evaluation_reasons/
get
/api/datasets/{dataset_id}/feature_flags/local_evaluation/
get
/api/datasets/{dataset_id}/feature_flags/my_flags/
get
/api/datasets/{dataset_id}/feature_flags/user_blast_radius/
post
Ingestion Warnings
/api/datasets/{dataset_id}/ingestion_warnings/
get
Insights
/api/datasets/{dataset_id}/insights/
get
/api/datasets/{dataset_id}/insights/
post
/api/datasets/{dataset_id}/insights/{id}/
get
/api/datasets/{dataset_id}/insights/{id}/
put
/api/datasets/{dataset_id}/insights/{id}/
patch
/api/datasets/{dataset_id}/insights/{id}/
del
/api/datasets/{dataset_id}/insights/{id}/activity/
get
/api/datasets/{dataset_id}/insights/{id}/viewed/
post
/api/datasets/{dataset_id}/insights/activity/
get
/api/datasets/{dataset_id}/insights/cancel/
post
/api/datasets/{dataset_id}/insights/funnel/
get
/api/datasets/{dataset_id}/insights/iframe/
post
/api/datasets/{dataset_id}/insights/my_last_viewed/
get
/api/datasets/{dataset_id}/insights/path/
get
/api/datasets/{dataset_id}/insights/path/
post
/api/datasets/{dataset_id}/insights/retention/
get
/api/datasets/{dataset_id}/insights/timing/
post
/api/datasets/{dataset_id}/insights/trend/
get
Funnel
/api/datasets/{dataset_id}/insights/funnel/
post
Trend
/api/datasets/{dataset_id}/insights/trend/
post
Integrations
/api/datasets/{dataset_id}/integrations/
get
/api/datasets/{dataset_id}/integrations/
post
/api/datasets/{dataset_id}/integrations/{id}/
get
/api/datasets/{dataset_id}/integrations/{id}/
del
/api/datasets/{dataset_id}/integrations/{id}/channels/
get
KPI Rows
/api/datasets/{dataset_id}/kpi_rows/
post
/api/datasets/{dataset_id}/kpi_rows/{id}/
put
/api/datasets/{dataset_id}/kpi_rows/{id}/
patch
/api/datasets/{dataset_id}/kpi_rows/{id}/
del
KPIs
/api/datasets/{dataset_id}/kpis/
get
/api/datasets/{dataset_id}/kpis/
post
/api/datasets/{dataset_id}/kpis/{id}/
get
/api/datasets/{dataset_id}/kpis/{id}/
put
/api/datasets/{dataset_id}/kpis/{id}/
patch
/api/datasets/{dataset_id}/kpis/{id}/
del
Persons
/api/datasets/{dataset_id}/persons/
get
/api/datasets/{dataset_id}/persons/{id}/
get
/api/datasets/{dataset_id}/persons/{id}/
put
/api/datasets/{dataset_id}/persons/{id}/
patch
/api/datasets/{dataset_id}/persons/{id}/
del
/api/datasets/{dataset_id}/persons/{id}/activity/
get
/api/datasets/{dataset_id}/persons/{id}/delete_property/
post
/api/datasets/{dataset_id}/persons/{id}/properties_timeline/
get
/api/datasets/{dataset_id}/persons/{id}/split/
post
/api/datasets/{dataset_id}/persons/{id}/update_property/
post
/api/datasets/{dataset_id}/persons/activity/
get
/api/datasets/{dataset_id}/persons/cohorts/
get
/api/datasets/{dataset_id}/persons/funnel/
get
/api/datasets/{dataset_id}/persons/funnel/
post
/api/datasets/{dataset_id}/persons/lifecycle/
get
/api/datasets/{dataset_id}/persons/path/
get
/api/datasets/{dataset_id}/persons/path/
post
/api/datasets/{dataset_id}/persons/retention/
get
/api/datasets/{dataset_id}/persons/stickiness/
get
/api/datasets/{dataset_id}/persons/trends/
get
/api/datasets/{dataset_id}/persons/values/
get
Plugin Configs
/api/datasets/{dataset_id}/plugin_configs/
get
/api/datasets/{dataset_id}/plugin_configs/
post
/api/datasets/{dataset_id}/plugin_configs/{parent_lookup_plugin_config_id}/logs/
get
/api/datasets/{dataset_id}/plugin_configs/{id}/
get
/api/datasets/{dataset_id}/plugin_configs/{id}/
put
/api/datasets/{dataset_id}/plugin_configs/{id}/
patch
/api/datasets/{dataset_id}/plugin_configs/{id}/
del
/api/datasets/{dataset_id}/plugin_configs/{id}/frontend/
get
/api/datasets/{dataset_id}/plugin_configs/{id}/job/
post
/api/datasets/{dataset_id}/plugin_configs/rearrange/
patch
Property Definitions
/api/datasets/{dataset_id}/property_definitions/
get
/api/datasets/{dataset_id}/property_definitions/{id}/
get
/api/datasets/{dataset_id}/property_definitions/{id}/
put
/api/datasets/{dataset_id}/property_definitions/{id}/
patch
/api/datasets/{dataset_id}/property_definitions/{id}/
del
Query
/api/datasets/{dataset_id}/query/
get
Session Recordings
/api/datasets/{dataset_id}/session_recordings/
get
/api/datasets/{dataset_id}/session_recordings/{id}/
get
/api/datasets/{dataset_id}/session_recordings/{id}/
del
/api/datasets/{dataset_id}/session_recordings/{id}/snapshots/
get
/api/datasets/{dataset_id}/session_recordings/properties/
get
Surveys
/api/datasets/{dataset_id}/surveys/
get
/api/datasets/{dataset_id}/surveys/
post
/api/datasets/{dataset_id}/surveys/{id}/
get
/api/datasets/{dataset_id}/surveys/{id}/
put
/api/datasets/{dataset_id}/surveys/{id}/
patch
/api/datasets/{dataset_id}/surveys/{id}/
del
Tags
/api/datasets/{dataset_id}/tags/
get
Uploaded Media
/api/datasets/{dataset_id}/uploaded_media/
post
Warehouse Table
/api/datasets/{dataset_id}/warehouse_table/
get
/api/datasets/{dataset_id}/warehouse_table/
post
/api/datasets/{dataset_id}/warehouse_table/{id}/
get
/api/datasets/{dataset_id}/warehouse_table/{id}/
put
/api/datasets/{dataset_id}/warehouse_table/{id}/
patch
/api/datasets/{dataset_id}/warehouse_table/{id}/
del
Change
/api/datasets/{id}/change/
get
Is Generating Demo Data
/api/datasets/{id}/is_generating_demo_data/
get
Reset Token
/api/datasets/{id}/reset_token/
patch
Organization
/api/organization/
get
/api/organization/{id}/
get
Projects
/api/projects/
get
/api/projects/{id}/
get
/api/projects/{id}/
put
/api/projects/{id}/
patch
/api/projects/{id}/change/
get
/api/projects/{parent_lookup_project_id}/domains/
get
/api/projects/{parent_lookup_project_id}/domains/
post
/api/projects/{parent_lookup_project_id}/domains/{id}/
get
/api/projects/{parent_lookup_project_id}/domains/{id}/
put
/api/projects/{parent_lookup_project_id}/domains/{id}/
patch
/api/projects/{parent_lookup_project_id}/domains/{id}/
del
/api/projects/{parent_lookup_project_id}/domains/{id}/verify/
post
/api/projects/{parent_lookup_project_id}/invites/
get
/api/projects/{parent_lookup_project_id}/invites/
post
/api/projects/{parent_lookup_project_id}/invites/{id}/
del
/api/projects/{parent_lookup_project_id}/invites/bulk/
post
/api/projects/{parent_lookup_project_id}/members/
get
/api/projects/{parent_lookup_project_id}/members/{user__uuid}/
get
/api/projects/{parent_lookup_project_id}/plugins/
get
/api/projects/{parent_lookup_project_id}/plugins/
post
/api/projects/{parent_lookup_project_id}/plugins/{id}/
get
/api/projects/{parent_lookup_project_id}/plugins/{id}/
put
/api/projects/{parent_lookup_project_id}/plugins/{id}/
patch
/api/projects/{parent_lookup_project_id}/plugins/{id}/
del
/api/projects/{parent_lookup_project_id}/plugins/{id}/check_for_updates/
get
/api/projects/{parent_lookup_project_id}/plugins/{id}/source/
get
/api/projects/{parent_lookup_project_id}/plugins/{id}/update_source/
patch
/api/projects/{parent_lookup_project_id}/plugins/{id}/upgrade/
post
/api/projects/{parent_lookup_project_id}/plugins/activity/
get
/api/projects/{parent_lookup_project_id}/plugins/repository/
get
Domains
Invites
Members
Plugins
Prompts
/api/prompts/my_prompts/
patch
Users
/api/users/
get
/api/users/{uuid}/
get
/api/users/{uuid}/
put
/api/users/{uuid}/
patch
/api/users/{uuid}/request_email_verification/
post
/api/users/{uuid}/start_2fa_setup/
get
/api/users/{uuid}/validate_2fa/
post
/api/users/{uuid}/verify_email/
post
Powered by
/api/datasets/{dataset_id}/kpis/{id}/
put
https://example.com/api/datasets/
{dataset_id}
/kpis/
{id}
/
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
