Scheduled data export

Properties

Property	Type	Description
scheduled_data_export_id	string	Must be a UUID. The unique identifier of the scheduled data export.
environment	string	The dataset used by the scheduled data export. Either `sandbox` or `production`.
created_at	string	The time at which the scheduled data export was created.
created_by	object	An object indicating the user or API key that created the scheduled data export. See Authentication.
status	string	The current status of the scheduled data export. One of `active`, `paused`, or `archived`.
name	string	The name of the scheduled data export.
frequency	object	The frequency at which the scheduled data export runs. See below for more details.
adapter	object	The adapter used to send the export once it's compiled. See below for more details.
export_type	string	The type of scheduled data export. Only `policy_export` is currently supported.
data_range	string	The range used to capture data for the export. One of `today`, `week_to_date`, `month_to_date`, `since_last_run`, or `full`.
latest_run	object, null	The latest run for the scheduled data export, if one exists. See below for more details.

Example

{
  "scheduled_data_export_id": "4ab082f2-864e-4bcf-bc17-75664a25f2e1",
  "environment": "sandbox",
  "created_at": "2019-03-15T09:55:13.627Z",
  "created_by": {
    "type": "api_key",
    "id": "313f7511-c16a-4fdb-ba49-25a80a9b571c",
    "owner_id": "da20903b-7f0d-4318-96bd-6df78514e2fd"
  },
  "status": "active",
  "name": "Daily policies export",
  "frequency": {
    "type": "daily",
    "time_of_day": "09:00"
  },
  "adapter": {
    "type": "sftp",
    "host": "localhost",
    "username": "someuser",
    "path": "/some/path/"
  },
  "export_type": "policy_export",
  "data_range": "since_last_run"
}