Mayson Monorepo Documentation
    Preparing search index...

    The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

    Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

    interface ReportType {
        id: string;
        object: "reporting.report_type";
        data_available_end: number;
        data_available_start: number;
        default_columns: string[];
        livemode: boolean;
        name: string;
        updated: number;
        version: number;
    }
    Index

    Properties

    id: string

    The ID of the Report Type, such as balance.summary.1.

    object: "reporting.report_type"

    String representing the object's type. Objects of the same type share the same value.

    data_available_end: number

    Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

    data_available_start: number

    Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

    default_columns: string[]

    List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)

    livemode: boolean

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

    name: string

    Human-readable name of the Report Type

    updated: number

    When this Report Type was latest updated. Measured in seconds since the Unix epoch.

    version: number

    Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.