Snapshots
The Reporting API does not provide a full snapshot of historical data. However, if a full dataset is desired, we can generate a one-time data snapshot for an additional cost.
We must generate the snapshot before it can be downloaded. This process can take several days depending on the amount of data on the platform. In order to keep file sizes reasonable for downloading, multiple files may be generated for each resource. Once snapshots have been generated, we provide you with a GUID which can be used to download the snapshot files.
The response is in an Avro file format with gzip compression. Files can be saved with .gz extension and then unpacked using gunzip.
More information about Avro can be found on the official Avro documentation page. Avro files rely on schemas. When Avro data is read, the schema used when writing it is always present. This permits each datum to be written with no per-value overheads, making serialization both fast and small. This also facilitates use with dynamic scripting languages, since data, together with its schema, is fully self-describing.
We retain snapshot files long enough for you to retrieve them; however, these files do not remain available long-term. Once you have verified that the files have been retrieved, we remove the files from storage. It is your responsibility to download and retain the files in their own system.
We generate snapshots for the following resources:
- Accounts
- Devices
- Goals
- Members
- Notification profiles
- Transactions
- Users