| Warningpanel | ||||||
|---|---|---|---|---|---|---|
| ||||||
DeprecatedThis API is deprecated. You should use the CommCare Data Export Tool (DET) or the List Forms API instead. | ||||||
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
File size limitExports we will serve via this API have a file size limitation of 10MB. Files larger than this may not successfully download. |
...
| Code Block |
|---|
http://www.commcarehq.org/a/[domain]/reports/export/?export_tag="[form xmlns]"&previous_export=[previous export]&format=[format] |
Parameter | Value | Examples |
|---|---|---|
export_tag | The xmlns of the form to download. | %22http://openrosa.org/foo/my/form/xmlns%22 (NOTE the escaped quotes around the form xmlns. It will not work without them. |
previous_export | The previous export id (optional) | abc123fda2b3c2gad5125 |
format | Export format (optional) | csv = csv, xlsx = Excel 2007 (this is the default), xls = Excel (previous version), html = HTML view, json = JSON dump, raw = zipped xml submission files. No other values are allowed. |
include_errors | Whether to include errors (duplicates or things the server couldn't parse) (option) | True, False (default) |
max_column_size | The maximum length (in characters) that should be used for the column headers. Headers beyond this size will be truncated. | any number, the default is 2000 |
The "previous_export" parameter is optional, but can be used to download partial data. With each download, CommCareHQ will return this value in the "X-CommCareHQ-Export-Token" header in the response. You can save this token and pass it back and only data since your last download will be returned. This parameter does not work with the raw export format.
...
You can use the following url parameter:
Parameter | Value | Examples |
|---|---|---|
include_closed | true/false (defaults to false) | include_closed=true |
format | (same as above) |
|
Using with curl from the linux command line
...