Export all event data for a given project that were uploaded within a specified range of dates. The results are returned as a zipped archive of JSON files, one or multiple files per hour.
In the examples below the parameters are highlighted in purple, and the values in red are what you need to replace with the parameters you are specifically interested in.
Unzipping Instructions:
- Mac: Open the zip file or use the terminal.
- Windows: Use WinRAR or 7zip.
Table of Contents
IMPORTANT NOTE: The specified date range is the time of when the event data was uploaded to Amplitude servers (see server_upload_time). The Export API returns timestamp the values in UTC. Data is available to export at a minimum within 2 hours of when our servers received it. For example, data sent between 8-9PM will begin loading at 9PM and will be available via the Export API at 11PM. Note that there is no delay in platform reporting--this delay is only for data you wish to export.
Export API is not supported for a cross-project view because the view doesn’t own any data. To export all the data in the view, you would need to call the Export API on the underlying projects that actually ingested the data.
Export API Parameters
Authenticate via basic authentication with the credentials YOUR_API_KEY:YOUR_SECRET_KEY. More information on how to find your API and Secret Keys here.
GET https://amplitude.com/api/2/export
Parameters
| Parameter | Description |
|---|---|
| start (required) | First hour included in data series, formatted YYYYMMDDTHH (e.g. '20150201T05'). |
| end (required) |
Last hour included in data series, formatted YYYYMMDDTHH (e.g. '20150203T20'). IMPORTANT NOTE: If you wish to export a whole day, then it would be from T00 to T23. The maximum time range you can query at once is 365 days. Size limit is 4GB. The specified date range is the time of when the event data was uploaded to Amplitude servers (see server_upload_time) not when the event actually happened (client_time). The Export API returns timestamp the values in UTC. |
Returns
The response is a zipped archive of JSON files, with potentially multiple files per hour. Note that events prior to 2014-11-12 will be grouped by day instead of by the hour. If you request data for a time range during which no data has been collected for the project, then you will receive a 404 response from our server.
There is one event JSON object per line in the file, with the following schema:
{
"server_received_time": UTC ISO-8601 formatted timestamp,
"app": int,
"device_carrier": string,
"$schema":int,
"city": string,
"user_id": string,
"uuid": UUID,
"event_time": UTC ISO-8601 formatted timestamp,
"platform": string,
"os_version": string,
"amplitude_id": long,
"processed_time": UTC ISO-8601 formatted timestamp,
"user_creation_time": UTC ISO-8601 formatted timestamp,
"version_name": string,
"ip_address": string,
"paying": boolean,
"dma": string,
"group_properties": dict,
"user_properties": dict,
"client_upload_time": UTC ISO-8601 formatted timestamp,
"$insert_id": string,
"event_type": string,
"library":string,
"amplitude_attribution_ids": string,
"device_type": string,
"device_manufacturer": string,
"start_version": string,
"location_lng": float,
"server_upload_time": UTC ISO-8601 formatted timestamp,
"event_id": int,
"location_lat": float,
"os_name": string,
"amplitude_event_type": string,
"device_brand": string,
"groups": dict,
"event_properties": dict,
"data": dict,
"device_id": string,
"language": string,
"device_model": string,
"country": string,
"region": string,
"is_attribution_event": bool,
"adid": string,
"session_id": long,
"device_family": string,
"sample_rate": null,
"idfa": string,
"client_event_time": UTC ISO-8601 formatted timestamp,
}
Example Request
curl -u API_Key:Secret_Key 'https://amplitude.com/api/2/export?start=20150201T5&end=20150203T20' >> yourfilename.zip
You should replace the red values with your project's API Key, Secret Key, the date range you're interested in, and the name of the file you want to export the data to.