Queries custom reports.
Operation description
Note
This operation queries the metadata of all operations reports. The statistics in the reports are not returned.
You can call this operation up to three times per second per account.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ReportId | long | No | The ID of the operations report that you want to query. If you do not specify an ID, all operations reports are queried. | 2 |
Response parameters
Fields in the Content parameter
| Field | Type | Description |
|---|---|---|
| reportId | Long | The ID of the report. |
| deliver | report | The type of the report. |
Fields in the report parameter
| Field | Type | Description |
|---|---|---|
| title | String | The title of the report. |
| format | String | The format of the report. Valid values:charttable |
| shape | String | The type of the chart. When format is set to table, ignore this field. Valid values:linepiebar |
| header | String[] | The fields that are used as the table headers. |
| legend | String | The fields that are used as the legends. |
| xAxis | String | The x-axis of the chart. If you do not specify a value, the chart does not have an x-axis. |
| yAxis | String | The y-axis of the chart. If you do not specify a value, the chart does not have a y-axis. |
Examples
Sample success responses
JSONformat
{
"Content": "\"data\": [{\"reportId\":2,\"deliver\":{\"report\":{\"title\":\"DomainPvUv\",\"format\":\"chart\",\"shape\":\"line\",\"xAxis\":\"ds\",\"yAxis\":\"cnt\",\"legend\":\"cnt_type\",\"header\":[\"ds\",\"cnt_type\",\"cnt\"]}}}",
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | A parameter is set to an invalid value. |
| 400 | TimeParseFailed | Failed to parse the time parameter. | Failed to parse the time parameter. |
| 400 | SubscriptionAlreadyExists | The subscription already exists. | The subscription already exists. |
| 400 | SubscriptionNotFound | The subscription is not found. | The subscription is not found. |
| 400 | NameAlreadyExists | The name already exists. | The name already exists. |
| 400 | DeliverExceedLimit | The maximum number of subscribed tasks is exceeded. | The number of tracking tasks has reached the upper limit. |
For a list of error codes, visit the Service error codes.