CommCare Data Export Tool

This feature requires a CommCare Software Plan.

This feature (CommCare Data Export Tool) is only available to CommCare users with a Pro Plan or higher. For more details, see the CommCare Software Plan page.

What is the CommCare Data Export Tool (DET)?

The CommCare Data Export Tool (DET) is a command-line interpreter tool that you can use to export data from CommCare HQ. The DET consists of a Python Library (a set of scripts). The scripts call the CommCare HQ API and export the data. You can export data to an excel sheet, or more commonly, to a database. 

 It is recommended to use the DET when working with large datasets. You can configure it to pull data on a schedule to automatically keep your data up to date or run it as a one-time data export.

Use case

Haik is a data analyst for a child immunization NGO specializing in tracking polio vaccinations in developing countries using CommCare. The increase of vaccination supplies and the training of competent healthcare workers to administer the vaccinations have significantly improved the child immunization program. More children are getting the vaccinations that they need. 

The program's success is leading to a considerable increase in the data collected. 

Haik needs to export data regularly to analyze and visualize it for the weekly reports. Manually exporting the data from CommCare HQ is not sustainable. Haik needs a way to export data in bulk in an automated manner. 

The CommCare Data Export Tool will help Haik. He can use the DET to pull data from one or more domains and combine data into one large data file, or database, for analysis.

The commcare-export tool offers no security features for dealing with PHI directly. If you intend to export PHI data from CommCare, please ensure the appropriate measures are in place to protect your data.

The data export tool does not change your data in CommCare HQ. It simply exports the data into a raw format that you can use for data insights and analytics.