获取用户行为数据源报表

开发环境

GET

/v1.3/user_action_set_reports/get

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
user_action_set_id*	integer	用户行为源 id，通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id。请注意，当填写的用户行为数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时，必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_id。
date_range*	struct	时间范围，日期格式，{"start_date":"2017-03-01","end_date":"2017-04-02"}
start_date*	string	开始时间点对应的时间戳，小于或等于 end_date 字段长度为 10 字节
end_date*	string	结束时间点对应的时间戳，小于或等于今天，且大于或等于 start_date 字段长度为 10 字节
time_granularity*	enum	时间粒度，针对流量的粒度，可选值：DAILY（按天汇总）, HOURLY（按小时汇总），默认小时，[枚举详情] 枚举列表：{ DAILY, HOURLY }
aggregation	enum	聚合维度，是否将结果按照指定类型细分，可选值'DOMAIN', 'ACTION_TYPE'，[枚举详情] 枚举列表：{ DOMAIN, ACTION_TYPE }

使用说明
1.
为提升数据上报文档阅读体验，相关文档将逐步迁移至 DataNexus。现邀请您抢鲜体验。

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/v1.3/user_action_set_reports/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>&account_id=<ACCOUNT_ID>&user_action_set_id=1111111111&date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}&time_granularity=HOURLY&aggregation=DOMAIN' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'user_action_set_id=1111111111' \
--data-urlencode 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
--data-urlencode 'time_granularity=HOURLY' \
--data-urlencode 'aggregation=DOMAIN'

响应示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "date": "2017-04-25",
                "hour": "11",
                "domain": "https://example.com",
                "raw_action_count": 4000,
                "identified_action_count": 2100,
                "identified_user_count": 1400
            }
        ]
    }
}

请求参数

Query 参数

access_token

string

必需

示例值:

<ACCESS_TOKEN>

timestamp

string

必需

示例值:

nonce

string

必需

示例值:

<NONCE>

account_id

string

必需

示例值:

<ACCOUNT_ID>

user_action_set_id

string

必需

示例值:

1111111111

date_range

string

必需

示例值:

{"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}

time_granularity

string

必需

示例值:

HOURLY

aggregation

string

必需

示例值:

DOMAIN

Header 参数

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id

示例值:

<ACCOUNT_ID>

user_action_set_id

integer

必需

用户行为源 id，通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id。请注意，当填写的用户行为数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时，必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_id。

示例值:

1111111111

date_range

string

必需

时间范围，日期格式，{"start_date":"2017-03-01","end_date":"2017-04-02"}

示例值:

{"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}

time_granularity

string

必需

时间粒度，针对流量的粒度，可选值：DAILY（按天汇总）, HOURLY（按小时汇总），默认小时，[枚举详情]
枚举列表：{ DAILY, HOURLY }

示例值:

HOURLY

aggregation

string

必需

聚合维度，是否将结果按照指定类型细分，可选值'DOMAIN', 'ACTION_TYPE'，[枚举详情]
枚举列表：{ DOMAIN, ACTION_TYPE }

示例值:

DOMAIN

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {6}]

返回数组列表

必需

修改于 2023-11-08 02:57:38

获取用户行为数据源

添加数据集

获取用户行为数据源报表

请求参数#

请求参数

返回响应

请求参数