2.1.1 Report object

Represents a generated report.

Fields

Field Type Description
id
required
String The unique ID of the generated report.
created
optional
Date The creation date and time of the report.
status
required
String constant The state of the generated report. Valid states are:

  • REQUESTED
  • GENERATED
  • REMOVED
  • FAILED
type
optional
String The report type.
details
optional
String Details pertaining to this report.
format
required
String The report file format. Examples: csv and xlsx.
url
optional
String The URL where the report can be retrieved from.