Attributes
- idstring
The unique identifier of the
ReportRun
object. - objectstring, value is "v2.reporting.report_run"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Time at which the object was created.
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - reportstring
The unique identifier of the
Report
object which was run. - report_
namestring The human-readable name of the
Report
which was run. - report_
parametersmap The parameters used to customize the generation of the report.
- resultnullable object
Details how to retrieve the results of a successfully completed
ReportRun
.- result.
fileobject Contains metadata about the file produced by the
ReportRun
, including its content type, size, and a URL to download its contents.- result.
file. content_ typeenum The content type of the file.
Possible enum valuescsv
CSV content type. Mime type of
text/csv
.zip
ZIP content type. Mime type of
application/zip
. - result.
file. download_ urlobject A pre-signed URL that allows secure, time-limited access to download the file.
- result.
file. download_url. expires_ atnullable timestamp The time that the URL expires.
- result.
file. download_url. urlstring The URL that can be used for accessing the file.
- result.
file. sizeinteger The total size of the file in bytes.
- result.
typeenum The type of the
ReportRun
result.Possible enum valuesfile
File result type.
- result_
optionsnullable object The options specified for customizing the output file of the
ReportRun
.- result_options.
compress_ filenullable boolean If set, the generated report file will be compressed into a ZIP folder. This is useful for reducing file size and download time for large reports.
- statusenum
The current status of the
ReportRun
.Possible enum valuesfailed
Report has failed to complete due to an error.
running
Report generation is in progress.
succeeded
Report has successfully generated.
- status_
detailsmap Additional details about the current state of the
ReportRun
. The field is currently only populated when aReportRun
is in thefailed
state, providing more information about why the report failed to generate successfully.
{ "created": "2025-08-26T00:00:00.000Z", "id": "reprun_test_xxx", "object": "v2.reporting.report_run", "report": "report_test_xxx", "report_name": "test report name", "report_parameters": { "interval_start": "2025-08-18T00:00:00.000Z", "interval_end": "2025-08-25T00:00:00.000Z" }, "result": null, "result_options": { "compress_file": false }, "status": "running", "status_details": {}, "livemode": false}