customReport Object

Request

Property Name

Type

Required

Description

id

integer

Required in Update Custom Report

Unique identifier for the report.

title

string

Required

Report title.

" & < > # / = ! \ ' ) characters not permitted.

info

string

Optional

Report description.

" & < > # / = ! \ ' ) characters not permitted.

category

string

Required

The report category code.

columns

array

Required

An array of objects representing the columns of the report.

Each object contains the following parameter: name   string   Required   

For a list of applicable name values, refer to Report Categories and click the Supported columns link.


Response

Property Name

Type

Description

id

integer

Unique identifier for the report.

title

string

Report title.

info

string

Report description.

category

string

The report category code.

columns

array

An array of objects representing the columns in the report.