The Report object

Reporting

Reports

The Report object

Attributes

idstring
The unique identifier of the Report object.

objectstring, value is "v2.reporting.report"
String representing the object’s type. Objects of the same type share the same value of the object field.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

namestring
The human-readable name of the Report.

parametersmap
Specification of the parameters that the Report accepts. It details each parameter’s name, description, whether it is required, and any validations performed.

The Report object

{
  "id": "4242",
  "name": "4242",
  "object": "4242",
  "parameters": {
    "4242": {
      "array_details": {
        "element_type": "enum",
        "enum_details": {
          "allowed_values": [
            "4242"
          ]
        }
      },
      "description": "4242",
      "enum_details": {
        "allowed_values": [
          "4242"
        ]
      },
      "required": true,
      "timestamp_details": {
        "max": "2025-01-01T00:00:00.000Z",
        "min": "2025-01-01T00:00:00.000Z"
      },
      "type": "array"
    }
  },
  "livemode": true
}

Need help? Contact Support.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc

The Report object

Attributes

idstring

objectstring, value is "v2.reporting.report"

livemodeboolean

namestring

parametersmap