Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

The ReportRun object 

Reporting
Report Runs
The ReportRun object

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 value false 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 values
        csv

        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 values
      file

      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 values
    failed

    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 a ReportRun is in the failed state, providing more information about why the report failed to generate successfully.

The ReportRun object
{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "4242",
  "object": "4242",
  "report": "4242",
  "report_name": "4242",
  "report_parameters": {
    "4242": {
      "array_value": {
        "items": [
          "4242"
        ]
      },
      "string_value": "4242",
      "timestamp_value": "2025-01-01T00:00:00.000Z"
    }
  },
  "result": {
    "file": {
      "content_type": "csv",
      "download_url": {
        "expires_at": "2025-01-01T00:00:00.000Z",
        "url": "4242"
      },
      "size": 4242
    },
    "type": "file"
  },
  "result_options": {
    "compress_file": true
  },
  "status": "failed",
  "status_details": {
    "4242": {
      "error_code": "file_size_above_limit",
      "error_message": "4242"
    }
  },
  "livemode": true
}