You need to enable JavaScript to run this app.
导航
获取用户有权限访问的画像报告列表 - GetInsightReportList
最近更新时间:2024.12.06 13:07:30首次发布时间:2024.07.10 15:50:09

请求说明

  • 请求方式:GET
  • 接口名称:GetInsightReportList
  • 请求地址:https://console.volcengine.com/cdp/open_platform/openapi

请求参数

参数

类型

是否必选

示例值

描述

Authorization

String

HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx

详细介绍请查阅调用方式文档

X-Tenant

Int

1

项目ID

X-Env

String

多环境下需指定环境信息,默认“dev”

Query

参数

类型

是否必选

示例值

描述

ApiAction

String

GetInsightReportList

固定值,对应“请求说明”中的“接口名称”

ApiVersion

String

2023-02-10

固定值,版本号: 2023-02-10

Body


返回参数

data数组元素字段内容

参数

类型

示例值

描述

reportId

Integer

1

报告Id

reportName

String

Openapi 报告

报告名称

subjectId

Integer

2

主体Id

desc

String

画像报告

描述信息

creator

String

user1

创建者

isMine

Boolean

true

是否是当前用户创建的:true,只看由我创建的报告

isPublic

Boolean

false

是否是“其他”洞察报告

createdAt

String

2023-02-17 07:32:53

创建时间

updatedAt

String

2023-02-17 07:32:53

更新时间

historyDate

Array[String]

2023-02-17

历史报告日期

请求示例


返回示例

{
  "data": [                                    // 报告列表
    {
      "reportId": 1,                           // 报告Id
      "reportName": "Openapi 报告",            //  报告名
      "subjectId": 2,                         //  主体Id
      "desc": "画像报告",                      //  描述信息
      "creator": "user1",                    //  创建者
      "isMine": true,                        //  是否是当前用户创建的:true,当前用户是此报告的创建者; 
      "isPublic": false,                     //  是否是“其他”洞察报告
      "createdAt": "2023-02-17 07:32:53",    //  创建时间
      "updatedAt": "2023-02-17 07:32:53",    //  更新时间
      "historyDate": [                       //  历史报告日期
        "2023-02-17"
      ]
    }
  ],
  "code": 0
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码

错误码

错误信息

说明

400

invalidParameter

PARAMETER INVALID

参数非法,检查入参。