Countly API Documentation

Countly Homepage
Help Center
Slack Channel

{{user.name}}Log In

Countly Resources

Here you'll find comprehensive guides to help you start working with Countly as quickly as possible.

HomeGuidesRecipesCountly APIReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Only admins can see thisEnable it for everyone

REST API Reference

Introduction

Core API

Drill API

get
/o?method=segmentation
get
/o?method=segmentation_users
get
/o?method=segmentation_meta
get
/o?method=segmentation_big_meta
get
/o?method=drill_bookmarks
get
/i/drill/add_bookmark
get
/i/drill/delete_bookmark

Push API

post
/i/pushes/create
post
/i/pushes/prepare
get
/i/pushes/message
get
/i/pushes/delete
get
/o/pushes/all
get
/i/pushes/active
post
/i/pushes/push

Geolocations

get
/i/geolocations/create
get
/i/geolocations/delete
get
/o?method=get_locations

Attribution API

get
/o/campaign
get
/o/campaign?data
get
/o/campaign?camp_id
get
/o/campaign?getTable
get
/i/campaign/create
get
/i/campaign/update
get
/i/campaign/delete
get
/i/campaign/hide
get
/i/campaign/show

Live API

get
/o?method=live
get
/o?method=live_graph

User Profiles API

get
/o?method=user_details&uid
get
/o?method=user_details

Funnels API

get
/o?method=funnel
get
/o?method=get_funnels
get
/i/funnels/add
get
/i/funnels/delete

DBViewer API

get
/o/db
get
/o/db?dbs=:db&collection=:collection
get
/o/db?dbs=:db&collection=:collection&document=:document

Compare API

get
/o/compare/events
get
/o/compare/apps

Cohorts API

get
/o?method=cohort
get
/o?method=get_cohorts
get
/o?method=get_cohort_list
get
/o?method=cohortdata
get
/i/cohorts/add
get
/i/cohorts/edit
get
/i/cohorts/delete

Data Migration

get
/o/datamigration/getmyimports
get
/o/datamigration/getmyexports
get
/o/datamigration/getstatus
get
/o/datamigration/validateconnection
get
/i/datamigration/sendexport
get
/i/datamigration/export
get
/i/datamigration/stop_export
get
/i/datamigration/delete_import
get
/i/datamigration/delete_export
get
/i/datamigration/delete_all
get
/i/datamigration/import
get
/i/datamigration/report_import

Feedback plugin

get
/o?method=star
get
/i/feedback/widgets/create
get
/i/feedback/widgets/remove
get
/i/feedback/widgets/edit
get
/o/feedback/data
get
/o/feedback/multiple-widgets-by-id
get
/o/feedback/widgets
get
/o/feedback/widget

Other Plugins

get
/o/slipping
get
/o?method=retention

Export API

get
/o/export/db

Whitelabeling

get
/o/whitelabeling/data
post
/i/whitelabeling/updateform

Alerts API

get
/i/alert/save
get
/i/alert/delete
get
/i/alert/status
get
/o/alert/list

Flows API

get
/o/flows

System Utility API

get
/o/system/overall
get
/o/system/memory
get
/o/system/disks
get
/o/system/cpu
get
/o/system/database
get
/o/system/healthcheck
get
/o/system/dbcheck
get
/o/system/plugins
get
/o/system/version

Dashboards API

get
/o/dashboards/all
get
/o/dashboards
get
/i/dashboards/create
get
/i/dashboards/update
get
/i/dashboards/delete
get
/o/dashboards/widget
get
/i/dashboards/add-widget
get
/i/dashboards/update-widget
get
/i/dashboards/remove-widget

Token manager

get
/o/token/check
get
/o/token/list
get
/i/token/create
get
/i/token/delete

Remote Config API

get
/o/sdk?method=fetch_remote_config
get
/o?method=remote-config
get
/i/remote-config/add-parameter
get
/i/remote-config/update-parameter
get
/i/remote-config/remove-parameter
get
/i/remote-config/add-condition
get
/i/remote-config/update-condition
get
/i/remote-config/remove-condition

A/B Testing API

get
/o?method=ab-testing
get
/o/ab-testing/check-models
get
/o/ab-testing/experiment
get
/o/ab-testing/experiment-detail
get
/i/ab-testing/add-experiment
get
/i/ab-testing/update-experiment
get
/i/ab-testing/remove-experiment
get
/i/ab-testing/start-experiment
get
/i/ab-testing/stop-experiment
get
/i/ab-testing/update-experiment-position

Notes API

get
/i/notes/save
get
/i/notes/delete
get
/o?method=notes
get
/o/notes

Tasks

get
/i/tasks/delete
get
/i/tasks/edit
get
/i/tasks/name
get
/i/tasks/update
get
/o/tasks/all
get
/o/tasks/check
get
/o/tasks/list
get
/o/tasks/task

Groups

get
/o/groups
get
/o/groups/group-users
get
/i/groups/create
get
/i/groups/update
get
/i/groups/delete
get
/i/groups/save-user-group

Powered by