查询我的报告列表

查询我的报告列表。

请求 URL

GET {base_url}/{api_path}/myreport/list?access_token={access_token}
注： 请使用 openapi/v1.0 调用该接口。

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 我的报告总数。
data Array<my_reports_list> 我的报告列表。
my_reports_list
参数 类型 说明
id Integer 报告的唯一 ID。
name String 报告名称。
dataset String 报告对应的数据集。
type String 报告类型。
  • custom_report：自定义报告。
  • default_report：默认报告。
creator String 报告创建者。

示例

请求示例

GET /openapi/v1.0/myreport/list?access_token=3GrX8Z0iXo3rtNnUiFmLACFUNKB3ExB6&sort_by=id&order_by=asc HTTP/1.1  
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 1,
            "name": "Inbound Queue Activity Analysis",
            "dataset": "inboundqueueactivityanalysis",
            "type": "custom_report",
            "creator": "Leo Ball"
        },
        {
            "id": 2,
            "name": "Agent Activity Analysis",
            "dataset": "agentactivityanalysis",
            "type": "custom_report",
            "creator": "Leo Ball"
        },
        {
            "id": 3,
            "name": "Extension Call Statistics",
            "dataset": "extcallstatistics",
            "type": "default_report",
            "creator": "Terrel Smith"
        }
    ]
}