Jump to Content

Countly Homepage Help Center Slack Channel

Countly Homepage Help Center Slack Channel Log In

Countly API

REST API Reference

Introduction

Core API

Drill API

/o?method=segmentationget
/o?method=segmentation_usersget
/o?method=segmentation_metaget
/o?method=segmentation_big_metaget
/o?method=drill_bookmarksget
/i/drill/add_bookmarkget
/i/drill/delete_bookmarkget

Push API

/i/pushes/createpost
/i/pushes/preparepost
/i/pushes/messageget
/i/pushes/deleteget
/o/pushes/allget
/i/pushes/activeget
/i/pushes/pushpost

Geolocations

/i/geolocations/createget
/i/geolocations/deleteget
/o?method=get_locationsget

Attribution API

/o/campaignget
/o/campaign?dataget
/o/campaign?camp_idget
/o/campaign?getTableget
/i/campaign/createget
/i/campaign/updateget
/i/campaign/deleteget
/i/campaign/hideget
/i/campaign/showget

Live API

/o?method=liveget
/o?method=live_graphget

User Profiles API

/o?method=user_details&uidget
/o?method=user_detailsget

Funnels API

/o?method=funnelget
/o?method=get_funnelsget
/i/funnels/addget
/i/funnels/deleteget

DBViewer API

/o/dbget
/o/db?dbs=:db&collection=:collectionget
/o/db?dbs=:db&collection=:collection&document=:documentget

Compare API

/o/compare/eventsget
/o/compare/appsget

Cohorts API

/o?method=cohortget
/o?method=get_cohortsget
/o?method=get_cohort_listget
/o?method=cohortdataget
/i/cohorts/addget
/i/cohorts/editget
/i/cohorts/deleteget

Data Migration

/o/datamigration/getmyimportsget
/o/datamigration/getmyexportsget
/o/datamigration/getstatusget
/o/datamigration/validateconnectionget
/i/datamigration/sendexportget
/i/datamigration/exportget
/i/datamigration/stop_exportget
/i/datamigration/delete_importget
/i/datamigration/delete_exportget
/i/datamigration/delete_allget
/i/datamigration/importget
/i/datamigration/report_importget

Feedback plugin

/o?method=starget
/i/feedback/widgets/createget
/i/feedback/widgets/removeget
/i/feedback/widgets/editget
/o/feedback/dataget
/o/feedback/multiple-widgets-by-idget
/o/feedback/widgetsget
/o/feedback/widgetget

Other Plugins

/o/slippingget
/o?method=retentionget

Export API

/o/export/dbget

Whitelabeling

/o/whitelabeling/dataget
/i/whitelabeling/updateformpost

Alerts API

/i/alert/saveget
/i/alert/deleteget
/i/alert/statusget
/o/alert/listget

Flows API

/o/flowsget

System Utility API

/o/system/overallget
/o/system/memoryget
/o/system/disksget
/o/system/cpuget
/o/system/databaseget
/o/system/healthcheckget
/o/system/dbcheckget
/o/system/pluginsget
/o/system/versionget

Dashboards API

/o/dashboards/allget
/o/dashboardsget
/i/dashboards/createget
/i/dashboards/updateget
/i/dashboards/deleteget
/o/dashboards/widgetget
/i/dashboards/add-widgetget
/i/dashboards/update-widgetget
/i/dashboards/remove-widgetget

Token manager

/o/token/checkget
/o/token/listget
/i/token/createget
/i/token/deleteget

Remote Config API

/o/sdk?method=fetch_remote_configget
/o?method=remote-configget
/i/remote-config/add-parameterget
/i/remote-config/update-parameterget
/i/remote-config/remove-parameterget
/i/remote-config/add-conditionget
/i/remote-config/update-conditionget
/i/remote-config/remove-conditionget

A/B Testing API

/o?method=ab-testingget
/o/ab-testing/check-modelsget
/o/ab-testing/experimentget
/o/ab-testing/experiment-detailget
/i/ab-testing/add-experimentget
/i/ab-testing/update-experimentget
/i/ab-testing/remove-experimentget
/i/ab-testing/start-experimentget
/i/ab-testing/stop-experimentget
/i/ab-testing/update-experiment-positionget

Notes API

/i/notes/saveget
/i/notes/deleteget
/o?method=notesget
/o/notesget

Tasks

/i/tasks/deleteget
/i/tasks/editget
/i/tasks/nameget
/i/tasks/updateget
/o/tasks/allget
/o/tasks/checkget
/o/tasks/listget
/o/tasks/taskget

Groups

/o/groupsget
/o/groups/group-usersget
/i/groups/createget
/i/groups/updateget
/i/groups/deleteget
/i/groups/save-user-groupget

Powered by

/o/ping

get

https://try.count.ly/o/ping

Server health check

This api allows to check if Countly server is running and has connection to the database

Language