# Countly API Documentation Documentation ## API Reference - [Introduction](https://api.count.ly/reference/rest-api-reference.md) - [/i](https://api.count.ly/reference/i.md): Writing sessions, metrics and events - [/api-key](https://api.count.ly/reference/api-key.md): Retrieve user's API_KEY - [/o/users/all](https://api.count.ly/reference/ousersall.md): Retrieve information about all users - [/o/users/me](https://api.count.ly/reference/ousersmeapi_keyapi_key.md): Retrieve information about user - [/o/apps/all](https://api.count.ly/reference/oappsall.md): Retrieve information about all apps - [/o/apps/mine](https://api.count.ly/reference/oappsmine.md): Retrieve information about user's apps - [/o/apps/details](https://api.count.ly/reference/oappsdetails.md): Retrieve detailed information about app users (available from v16.12) - [/o?method=locations](https://api.count.ly/reference/omethodlocations.md): Retrieve locations of the app - [/o?method=sessions](https://api.count.ly/reference/omethodsessions.md): Retrieve session information of the app - [/o?method=users](https://api.count.ly/reference/omethodusers.md): Retrieve users of the app - [/o?method=devices](https://api.count.ly/reference/omethoddevices.md): Retrieve devices information of the app - [/o?method=device_details](https://api.count.ly/reference/omethoddevice_details.md): Retrieve device details data of the app - [/o?method=carriers](https://api.count.ly/reference/omethodcarriers.md): Retrieve carriers of the app - [/o?method=app_versions](https://api.count.ly/reference/omethodapp_versions.md): Retrieve app versions data of the app - [/o?method=cities](https://api.count.ly/reference/omethodcities.md): Retrieve city locations of the app - [/o?method=events](https://api.count.ly/reference/omethodevents.md): Retrieve events of the app - [/o?method=get_events](https://api.count.ly/reference/omethodget_events.md): Retrieve list of events of the app - [/o?method=get_period_obj](https://api.count.ly/reference/omethodget_period_obj.md): Get information about period object selected in dashboard - [/o?method=top_events](https://api.count.ly/reference/omethodtop_events.md): Retrieve current user breakdown by metric - [/o?method=total_users](https://api.count.ly/reference/omethodtotal_users.md): Retrieve current user breakdown by metric - [/o/analytics/dashboard](https://api.count.ly/reference/oanalyticsdashboard.md): Retrieve analytics data for dashboard - [/o/analytics/countries](https://api.count.ly/reference/oanalyticscountries.md): Retrieve analytics data about countries - [/o/analytics/sessions](https://api.count.ly/reference/oanalyticssessions.md): Retrieve session data for specified period - [/o/analytics/metric](https://api.count.ly/reference/oanalyticsmetric.md): Retrieve metric data for specified period - [/o/analytics/events](https://api.count.ly/reference/oanalyticsevents.md): Retrieve event data for specified period - [/o/analytics/tops](https://api.count.ly/reference/oanalyticstops.md): Retrieve up to top 3 values for specified period - [/o/analytics/loyalty](https://api.count.ly/reference/oanalyticsloyalty.md): Retrieves loyalty data for specified period - [/o/analytics/frequency](https://api.count.ly/reference/oanalyticsfrequency.md): Retrieves frequency data for specified period - [/o/analytics/durations](https://api.count.ly/reference/oanalyticsdurations.md): Retrieves durations data for specified period - [/o/ping](https://api.count.ly/reference/oping.md): Server health check - [/i/users/create](https://api.count.ly/reference/iuserscreate.md): Create new user - [/i/users/update](https://api.count.ly/reference/iusersupdate.md): Update user - [/i/users/delete](https://api.count.ly/reference/iusersdelete.md): Delete users - [/i/users/deleteOwnAccount](https://api.count.ly/reference/iusersiusersdeleteownaccount.md): Used to delete own user account - [/i/apps/create](https://api.count.ly/reference/iappscreate.md): Create new app - [/i/apps/update](https://api.count.ly/reference/iappsupdate.md): Update app information - [/i/apps/reset](https://api.count.ly/reference/iappsreset.md): Reset all app data and events - [/i/apps/delete](https://api.count.ly/reference/iappsdelete.md): Delete app - [/i/bulk](https://api.count.ly/reference/ibulk.md): Bulk session, metric, event data writing - [/i/app_users/create](https://api.count.ly/reference/iapp_userscreate.md): Create new app user - [/i/app_users/update](https://api.count.ly/reference/iapp_usersupdate.md): Update existing app user - [/i/app_users/delete](https://api.count.ly/reference/iapp_usersdelete.md): Delete existing app user - [/i/app_users/export](https://api.count.ly/reference/iapp_usersexport.md): Export information about app user - [/i/app_users/deleteExport/:filename](https://api.count.ly/reference/iapp_usersdeleteexportfilename.md): Delete previously exported file - [/o/app_users/download/:filename](https://api.count.ly/reference/oapp_usersdownloadfilename.md): Download previously exported file - [/o?method=segmentation](https://api.count.ly/reference/omethodsegmentation.md): Breakdown of data for specific event by provided bucket - [/o?method=segmentation_users](https://api.count.ly/reference/omethodsegmentation_users.md): Get list of user uid properties for provided segmentation query - [/o?method=segmentation_meta](https://api.count.ly/reference/omethodsegmentation_meta.md): Fetches all segment data for provided event - [/o?method=segmentation_big_meta](https://api.count.ly/reference/omethodsegmentation_big_meta.md): Fetches segments for big list properties (available since 16.12) - [/o?method=drill_bookmarks](https://api.count.ly/reference/omethoddrill_bookmarks.md): Get bookmarked filter query from drill (available in drill plugin) - [/i/drill/add_bookmark](https://api.count.ly/reference/idrilladd_bookmark.md): Add drill query to bookmarks (available in drill plugin) - [/i/drill/delete_bookmark](https://api.count.ly/reference/idrilldelete_bookmark.md): Remove drill bookmark (available in drill plugin) - [/i/pushes/create](https://api.count.ly/reference/ipushescreate.md) - [/i/pushes/prepare](https://api.count.ly/reference/ipushesaudience.md) - [/i/pushes/message](https://api.count.ly/reference/ipushesrefresh.md) - [/i/pushes/delete](https://api.count.ly/reference/ipushesdelete.md) - [/o/pushes/all](https://api.count.ly/reference/opushes.md) - [/i/pushes/active](https://api.count.ly/reference/ipushesactive.md) - [/i/pushes/push](https://api.count.ly/reference/ipushespush.md) - [/i/geolocations/create](https://api.count.ly/reference/igeolocationscreate.md): Create new geolocation - [/i/geolocations/delete](https://api.count.ly/reference/igeolocationsdelete.md): Delete existing geolocation - [/o?method=get_locations](https://api.count.ly/reference/omethodget_locations.md): Get all global and application-specific geolocations - [/o/campaign](https://api.count.ly/reference/ocampaign.md): Retrieve data of all campaigns - [/o/campaign?data](https://api.count.ly/reference/ocampaigndata.md): Retrieve click, install and other data about provided campaigns - [/o/campaign?camp_id](https://api.count.ly/reference/ocampaigncamp_id.md): Retrieve data of specific campaign - [/o/campaign?getTable](https://api.count.ly/reference/ocampaigngettable.md): Retrieve click, install and other data about provided campaigns - [/i/campaign/create](https://api.count.ly/reference/icampaigncreate.md): Create a campaign - [/i/campaign/update](https://api.count.ly/reference/icampaignupdate.md): Update data for specific campaign - [/i/campaign/delete](https://api.count.ly/reference/icampaigndelete.md): Delete campaign - [/i/campaign/hide](https://api.count.ly/reference/icampaignhide.md): Delete campaign - [/i/campaign/show](https://api.count.ly/reference/icampaignshow.md): Delete campaign - [/o?method=live](https://api.count.ly/reference/omethodlive.md): Get online user data (available in live plugin) - [/o?method=live_graph](https://api.count.ly/reference/omethodlive_graph.md): Get online user data fro graph (available in live plugin) - [/o?method=user_details&uid](https://api.count.ly/reference/omethoduser_detailsuid.md): Retrieves detailed information about specific user (available in users plugin) - [/o?method=user_details](https://api.count.ly/reference/omethoduser_details.md): Get list of users (available in users plugin) - [/o?method=funnel](https://api.count.ly/reference/omethodfunnel.md): Get user data of passing specific funnel (available in funnel plugin) - [/o?method=get_funnels](https://api.count.ly/reference/omethodget_funnels.md): Get list of funnels (available in funnel plugin) - [/i/funnels/add](https://api.count.ly/reference/ifunnelsadd.md): Create new funnel - [/i/funnels/delete](https://api.count.ly/reference/ifunnelsdelete.md): Delete funnel - [/o/db](https://api.count.ly/reference/odb.md): View databases and collections - [/o/db?dbs=:db&collection=:collection](https://api.count.ly/reference/odbdbsdbcollectioncollection.md): View databases and collections - [/o/db?dbs=:db&collection=:collection&document=:document](https://api.count.ly/reference/odbdbsdbcollectioncollectiondocumentdocument.md): View databases and collections - [/o/compare/events](https://api.count.ly/reference/ocompareevents.md): Retrieves data for all provided events for comparison (Available in Compare plugin) - [/o/compare/apps](https://api.count.ly/reference/ocompareapps.md): Retrieves data for all provided apps for comparison (Available in Compare plugin) - [/o?method=cohort](https://api.count.ly/reference/omethodcohort.md): Get list of user uid properties in the cohort - [/o?method=get_cohorts](https://api.count.ly/reference/omethodget_cohorts.md): Get list of cohorts - [/o?method=get_cohort_list](https://api.count.ly/reference/omethodget_cohort_list.md): Get mapping of cohorts from id to name - [/o?method=cohortdata](https://api.count.ly/reference/omethodcohortdata.md): Get data about entering and existing cohort - [/i/cohorts/add](https://api.count.ly/reference/icohortsadd.md): Create new cohort - [/i/cohorts/edit](https://api.count.ly/reference/icohortsedit.md): Edit existing cohort - [/i/cohorts/delete](https://api.count.ly/reference/icohortsdelete.md): Delete cohort - [/o/datamigration/getmyimports](https://api.count.ly/reference/odatamigrationgetmyimports.md): Get list of my imports using data migration plugin - [/o/datamigration/getmyexports](https://api.count.ly/reference/odatamigrationgetmyexports.md): Get all exports created with data migration plugin - [/o/datamigration/getstatus](https://api.count.ly/reference/odatamigrationgetstatus.md): Get status of export by export id - [/o/datamigration/validateconnection](https://api.count.ly/reference/odatamigrationvalidateconnection.md): Validate if given token and address can be used to import data on other Countly server - [/i/datamigration/sendexport](https://api.count.ly/reference/idatamigrationsendexport.md): Send export to other Countly server - [/i/datamigration/export](https://api.count.ly/reference/idatamigrationexport.md): Export data - [/i/datamigration/stop_export](https://api.count.ly/reference/idatamigrationstop_export.md): Stop export process - [/i/datamigration/delete_import](https://api.count.ly/reference/idatamigrationdelete_import.md): Delete import - [/i/datamigration/delete_export](https://api.count.ly/reference/idatamigrationdelete_export.md): Delete export - [/i/datamigration/delete_all](https://api.count.ly/reference/idatamigrationdelete_all.md): Deletes all exports - [/i/datamigration/import](https://api.count.ly/reference/idatamigrationimport.md): Import exported data - [/i/datamigration/report_import](https://api.count.ly/reference/idatamigrationreport_import.md): Report successfully finished import process - [/o?method=star](https://api.count.ly/reference/omethodstar.md): Retrieves break down of app platform and app versions for which ratings were provided (Available in Star Rating plugin) - [/i/feedback/widgets/create](https://api.count.ly/reference/iweb-feedbackwidgetscreate.md): Create feedback widget and set configuration settings. - [/i/feedback/widgets/remove](https://api.count.ly/reference/iweb-feedbackwidgetsremove.md): Remove feedback widget and related data by your preference. - [/i/feedback/widgets/edit](https://api.count.ly/reference/iweb-feedbackwidgetsedit.md): Edit feedback widget status and configurations. - [/o/feedback/data](https://api.count.ly/reference/oweb-feedbackdata.md): Get feedback data. - [/o/feedback/multiple-widgets-by-id](https://api.count.ly/reference/oweb-feedbackmultiple-widgets-by-id.md): Get multiple widgets by ids array. - [/o/feedback/widgets](https://api.count.ly/reference/oweb-feedbackwidgets.md): Get widgets list by enabled state. - [/o/feedback/widget](https://api.count.ly/reference/oweb-feedbackwidget.md): Get single widget by ID. - [/o/slipping](https://api.count.ly/reference/oslipping.md): Retrieves information about users that are about to churn (available in Slipping Away plugin) - [/o?method=retention](https://api.count.ly/reference/omethodretention.md): Get retention data (available in retention plugin) - [/o/export/db](https://api.count.ly/reference/oexportdb.md) - [/o/whitelabeling/data](https://api.count.ly/reference/owhitelabelingdata.md): Getting all fields set to configure Countly. - [/i/whitelabeling/updateform](https://api.count.ly/reference/iwhitelabelingupdateform.md): Saves changes to whitelabeling settings - [/i/alert/save](https://api.count.ly/reference/ialertsave.md): create or update an alert - [/i/alert/delete](https://api.count.ly/reference/ialertdelete.md): delete an existing alert - [/i/alert/status](https://api.count.ly/reference/ialertstatus.md) - [/o/alert/list](https://api.count.ly/reference/oalertlist.md): list all alerts - [/o/flows](https://api.count.ly/reference/oflows.md): output flows of the app - [/o/system/overall](https://api.count.ly/reference/osystemoverall.md): Get current overall server load information - [/o/system/memory](https://api.count.ly/reference/osystemmemory.md): Get current server memory load information - [/o/system/disks](https://api.count.ly/reference/osystemdisks.md): Get current server disks load information - [/o/system/cpu](https://api.count.ly/reference/osystemcpu.md): Get current server CPU load information - [/o/system/database](https://api.count.ly/reference/osystemdatabase.md): Get current database load information. (At least for the version of MongoDB 3.6) - [/o/system/healthcheck](https://api.count.ly/reference/osystemhealthcheck.md): Get current server health. - [/o/system/dbcheck](https://api.count.ly/reference/osystemdbcheck.md): Get current database health. - [/o/system/plugins](https://api.count.ly/reference/osystemplugins.md): Gets list of all currently enabled plugins - [/o/system/version](https://api.count.ly/reference/osystemversion.md): Gets current countly version - [/o/dashboards/all](https://api.count.ly/reference/odashboardsall.md): Get all custom dashboards - [/o/dashboards](https://api.count.ly/reference/odashboards.md): Get dashboard info - [/i/dashboards/create](https://api.count.ly/reference/idashboardscreate.md): Create custom dashboards - [/i/dashboards/update](https://api.count.ly/reference/idashboardsupdate.md): Update custom dashboard - [/i/dashboards/delete](https://api.count.ly/reference/idashboardsdelete.md): Delete custom dashboard - [/o/dashboards/widget](https://api.count.ly/reference/odashboardswidget.md): Get widget info - [/i/dashboards/add-widget](https://api.count.ly/reference/idashboardsadd-widget.md): Create a new widget - [/i/dashboards/update-widget](https://api.count.ly/reference/idashboardsupdate-widget.md): Update a widget - [/i/dashboards/remove-widget](https://api.count.ly/reference/idashboardsremove-widget.md): Remove a widget - [/o/token/check](https://api.count.ly/reference/otokencheck.md): Get all custom dashboards - [/o/token/list](https://api.count.ly/reference/otokenlist.md): Get all custom dashboards - [/i/token/create](https://api.count.ly/reference/itokencreate.md): Get all custom dashboards - [/i/token/delete](https://api.count.ly/reference/itokendelete.md): Get all custom dashboards - [/o/sdk?method=fetch_remote_config](https://api.count.ly/reference/osdk.md): Fetch all remote config in sdk - [/o?method=remote-config](https://api.count.ly/reference/omethodremote-config.md): Fetch all remote config data - [/i/remote-config/add-parameter](https://api.count.ly/reference/iremote-configadd-parameter.md): Add parameter to remote config - [/i/remote-config/update-parameter](https://api.count.ly/reference/iremote-configupdate-parameter.md): Update remote config parameter - [/i/remote-config/remove-parameter](https://api.count.ly/reference/iremote-configremove-parameter.md): Delete remote config parameter - [/i/remote-config/add-condition](https://api.count.ly/reference/iremote-configadd-condition.md): Add remote config condition - [/i/remote-config/update-condition](https://api.count.ly/reference/iremote-configupdate-condition.md): Update remote config condition - [/i/remote-config/remove-condition](https://api.count.ly/reference/iremote-configremove-condition.md): Delete remote config condition - [/o?method=ab-testing](https://api.count.ly/reference/omethodab-testing.md): Fetch all ab testing experiment - [/o/ab-testing/check-models](https://api.count.ly/reference/oab-testingcheck-models.md): Check if ab testing models available - [/o/ab-testing/experiment](https://api.count.ly/reference/oab-testingexperiment.md): Fetch experiment details - [/o/ab-testing/experiment-detail](https://api.count.ly/reference/oab-testingexperiment-detail.md): Fetch experiment results - [/i/ab-testing/add-experiment](https://api.count.ly/reference/iab-testingadd-experiment.md): Add new ab testing experiment - [/i/ab-testing/update-experiment](https://api.count.ly/reference/iab-testingupdate-experiment.md): Update ab testing experiment - [/i/ab-testing/remove-experiment](https://api.count.ly/reference/iab-testingremove-experiment.md): Remove ab testing experiment - [/i/ab-testing/start-experiment](https://api.count.ly/reference/iab-testingstart-experiment.md): Start an ab testing experiment - [/i/ab-testing/stop-experiment](https://api.count.ly/reference/iab-testingstop-experiment.md): Stop an ab testing experiment - [/i/ab-testing/update-experiment-position](https://api.count.ly/reference/iab-testingupdate-experiment-position.md): Update experiment position on the grid - [/i/notes/save](https://api.count.ly/reference/inotessave.md): Saves new note or updates existing note - [/i/notes/delete](https://api.count.ly/reference/inotesdelete.md): Delete existing note - [/o?method=notes](https://api.count.ly/reference/omethodnotes.md): Gets all notes, which are visible to user - [/o/notes](https://api.count.ly/reference/onotes.md): Gets all notes, which are visible to user. Same as /o?method=notes - [/i/tasks/delete](https://api.count.ly/reference/itasksdelete.md): Deletes task - [/i/tasks/edit](https://api.count.ly/reference/itasksedit.md): Edits task - [/i/tasks/name](https://api.count.ly/reference/itasksname.md): Renames task - [/i/tasks/update](https://api.count.ly/reference/itasksupdate.md): Runs task again - [/o/tasks/all](https://api.count.ly/reference/otasksall.md): Gets all tasks. - [/o/tasks/check](https://api.count.ly/reference/otaskstask.md): Gets status for task - [/o/tasks/list](https://api.count.ly/reference/otaskslist.md): Gets list of tasks. Used for displaying tasks in table - [/o/tasks/task](https://api.count.ly/reference/otaskstask-1.md): Gets all information about task - [/o/groups](https://api.count.ly/reference/ogroups.md): Retrieve existing groups - [/o/groups/group-users](https://api.count.ly/reference/ogroupsgroup-users.md): Retrieve users of specific group - [/i/groups/create](https://api.count.ly/reference/igroupscreate.md): Create a new group - [/i/groups/update](https://api.count.ly/reference/igroupsupdate.md): Update an existing group - [/i/groups/delete](https://api.count.ly/reference/igroupsdelete.md): Delete an existing group - [/i/groups/save-user-group](https://api.count.ly/reference/igroupssave-user-groups.md): Add user to a group or remove from current group