Archives Endpoint

This endpoint allows you to list the data archives associated with your account.

Listing Archives

A GET returns the archives for your organization with the following fields.

  • archive_type - the type of the archive: message, run (string) (filterable as archive_type)
  • start_date - the UTC date of the archive (string) (filterable as before and after)
  • period - daily for daily archives, monthly for monthly archives (string) (filterable as period)
  • record_count - number of records in the archive (int)
  • size - size of the gziped archive content (int)
  • hash - MD5 hash of the gziped archive (string)
  • download_url - temporary download URL of the archive (string)

Example:

GET /api/v2/archives.json?archive_type=message&before=2017-05-15&period=daily

Response is a list of the archives on your account

{
    "next": null,
    "previous": null,
    "count": 248,
    "results": [
    {
        "archive_type":"message",
        "start_date":"2017-02-20",
        "period":"daily",
        "record_count":1432,
        "size":2304,
        "hash":"feca9988b7772c003204a28bd741d0d0",
        "download_url":"<redacted>"
    },
    ...
}