1.3.3.1 事件分析

优质
小牛编辑
133浏览
2023-12-01

使用此功能前请先购买分析云

功能

根据站点ID获取站点事件分析报告数据。

接口

  • 百度商业账号
    https://api.baidu.com/json/tongji/v1/ReportService/getAnalyticsData
    
  • 百度账号
    https://openapi.baidu.com/rest/2.0/tongji/report/getAnalyticsData
    

用户相关性

用户相关

应用级请求参数

参数名参数类型是否必需描述
site_idint站点id
methodstring查询报告对应url,事件分析对应event/a
start_datestring查询起始时间,示例:"20200601"
end_datestring查询结束时间,示例:"20200603"
metricsarray of obj或json string指标,支持基础指标、计算指标两种类型
dimensionsarray of obj或json string维度
wherestring[]筛选条件
orderstring维度指标排序,示例:"metric_0,desc"
granstring时间粒度,默认全部,示例:"day" 。
支持的枚举值包括:default/hour/day/week/month/year

指标(metrics)说明

格式为 对象数组 或 对象数组对应的json字符串。对象类型支持基础指标对象、计算指标对象两类。一个请求中可以同时包含基础指标和计算指标。

基础指标

对象key值描述如下:

参数名参数类型是否必须描述
eventstring事件标识符
aggregationstring聚合方式,包括聚合函数和属性标识符,二者用逗号分隔
filterobj过滤条件,格式同where。如无过滤条件,传{"items":[],"op":"AND"}

聚合方式(aggregation)说明

aggregation说明
sum,1总次数
distinctcount,virtualvisitor_id触发用户数
visitory_avg,1人均次数
distinctcount,visitdomain受访域名的去重数
distinctcount,page_name页面地址的去重数
distinct_count,xxxxxx为当前事件所关联的属性的标识符

事件标识符、属性标识符、事件关联的属性说明:

  • 事件标识符为“管理->分析云设置->数据管理->基础事件、复合事件”标识符列。
  • 属性标识符为“管理->分析云设置->数据管理->事件属性、用户属性”标识符列。
  • 事件关联的属性可以通过点击对应事件操作列里的“编辑属性”进行查看和编辑。
  • 复合事件的属性为子事件的属性交集。
  • 所有事件默认关联所有用户属性。
  • 预置事件可以手动关联事件属性。
  • 圈选事件默认关联40个预置属性,可以取消关联某些预置属性。

基础指标示例

[
    {
        "event":"any_",
        "aggregation":"sum,1",
        "filter":{
            "items":[

            ],
            "op":"AND"
        }
    }
]
计算指标

对象key值描述如下:

参数名参数类型是否必须描述
idint计算指标id
namestring计算指标名称
labelstring计算指标label
expressionarray计算指标表达式
formatTypeint结果格式化类型,默认是1
expiredboolean是否已过期,默认是false
isPredefinedboolean是否是预定义,默认是false
groupIdint分组id,默认是0

计算指标表达式(expression)说明

expression是一个数组,共三个元素。第一、第三个元素是一个基础指标类型的对象,第二个元素固定为“/”。

结果格式化类型(formatType)说明

formatType说明
1结果是一个百分比,保留两位小数
2结果是一个整数
3结果是一个小数,保留两位小数

计算指标示例

[
    {
        "id":3340,
        "name":"test",
        "label":"test",
        "expression":[
            {
                "event":"any_",
                "aggregation":"distinct_count,virtual_visitor_id__",
                "filter":{
                    "items":[

                    ],
                    "op":"AND"
                }
            },
            "/",
            {
                "event":"any_",
                "aggregation":"sum,1",
                "filter":{
                    "items":[

                    ],
                    "op":"AND"
                }
            }
        ],
        "formatType":1,
        "expired":false,
        "isPredefined":false,
        "groupId":0
    }
]

维度(dimensions)说明

格式为 对象数组 或 json字符串。对象key值描述如下:

参数名参数类型是否必须描述
keystring属性标识符
discretizestring离散化,无传null

维度示例

[
    {
        "key":"province_",
        "discretize":null
    },
    {
        "key":"keyword_",
        "discretize":null
    }
]

查询参数(where)说明

格式为 对象数组 或 json字符串。对象key值描述如下:

参数名参数类型是否必须描述
opstring属性标识符,取值为“AND”或“OR”
itemsarray条件对象的数组
items[i].keystring属性标识符
items[i].opstring运算逻辑
当key为字符串型的属性时,可选的取值为“=”、“!=”、“LIKE”、“NOTLIKE”、“WILDCARD”;
当key为数值型的属性时,可选的取值为”>”、“<”、“=”、“>=”、“<=”、“!=”;
当key为布尔型的属性时,可选的取值为“是”、“否” 。
items[i].valuearray字符串数组

查询参数示例

{
    "op":"AND",
    "items":[
        {
            "key":"adtype_",
            "op":"=",
            "val":[
                "百度品牌植入"
            ]
        },
        {
            "key":"landingpageurl_",
            "op":"=",
            "val":[
                "https://mtj.baidu.com/web/welcome/login"
            ]
        }
    ]
}

排序条件(order)参数

通过string类型指定,示例如下:

  • 时间维度顺序
    dimension_time,asc
    
  • 第1个维度倒序,注意是从0开始编号
    dimension_0,desc
    
  • 第2个指标顺序,注意是从0开始编号
    metric_1,asc
    

可选参数

参数名参数类型是否必需描述
visitorSegmentIdint分群id
visitorFilterobj分群过滤条件
uIdSwitchstring策略类型,设备ID策略(default)/用户ID策略(uid),默认default
isPromotionint是否仅查询推广数据,默认是0,表示查询所有数据
graphint图表类型,0表示表格,3表示数值图(返回结果中包括上一个时间段的环比数值),默认是0

返回格式

参数名参数类型是否必须描述
result.detailDataReportData报告数据
result.totalDataReportData报告数据
  • ReportData结构
参数名参数类型是否必须描述
metricFieldsarray of obj指标数组(表头),obj中包含指标列列名及单位
dimensionFieldsarray of string维度数组(表头)
xAxisarray of string日期列,totalData中无
truncateCountint每日/周最多多少条数据,totalData中无
metricRowsarray of array指标值数组
dimensionRowsarray of array维度值数组

示例

请求示例

  • 百度度商业账号

请求

{
    "header":{
        "username":"***",
        "password":"***",
        "token":"***",
        "account_type":1
    },
    "body":{
        "site_id":9886941,
        "start_date":"20200601",
        "end_date":"20200603",
        "method":"event/a",
        "metrics":[
            {
                "event":"any_",
                "aggregation":"sum,1",
                "filter":{
                    "items":[

                    ],
                    "op":"AND"
                }
            },
            {
                "id":3340,
                "name":"test",
                "label":"test",
                "expression":[
                    {
                        "event":"any_",
                        "aggregation":"distinct_count,virtual_visitor_id__",
                        "filter":{
                            "items":[

                            ],
                            "op":"AND"
                        }
                    },
                    "/",
                    {
                        "event":"any_",
                        "aggregation":"sum,1",
                        "filter":{
                            "items":[

                            ],
                            "op":"AND"
                        }
                    }
                ],
                "formatType":1,
                "expired":false,
                "isPredefined":false,
                "groupId":0
            }
        ],
        "order":"metric_0,desc",
        "dimensions":[
            {
                "key":"province_",
                "discretize":null
            },
            {
                "key":"keyword_",
                "discretize":null
            }
        ],
        "where":{
            "op":"AND",
            "items":[
                {
                    "key":"province_",
                    "op":"LIKE",
                    "val":[
                        "上海"
                    ]
                },
                {
                    "key":"keyword_",
                    "op":"WILDCARD",
                    "val":[
                        "百度统计"
                    ]
                }
            ]
        },
        "gran":"day"
    }
}
  • 百度账号
https://openapi.baidu.com/rest/2.0/tongji/report/getAnalyticsData?access_token=xxxxxxxx&site_id=xxxx&method=event/a&start_date=20190601&end_date=20190603&metrics=[{"event":"any_","aggregation":"sum,1","filter":{"items":[],"op":"AND"}}]&gran=day

响应示例

  • 百度商业账号
{
    "header": {
        "desc": "success",
        "failures": [],
        "oprs": 1,
        "succ": 1,
        "oprtime": 0,
        "quota": 1,
        "rquota": 49989,
        "status": 0
    },
    "body": {
        "data": [
            {
                "result": {
                    "detailData": {
                        "metricFields": [
                            {
                                "unit": "次",
                                "label": "任意事件的总次数(A)"
                            },
                            {
                                "unit": "%",
                                "label": "test(B)"
                            }
                        ],
                        "dimensionFields": [
                            "date_",
                            "province_",
                            "keyword_"
                        ],
                        "xAxis": [
                            "2020/06/01",
                            "2020/06/02",
                            "2020/06/03"
                        ],
                        "truncateCount": 6,
                        "metricRows": [
                            [
                                19905,
                                2.17
                            ],
                            [
                                17284,
                                2.09
                            ],
                            [
                                11167,
                                2.72
                            ]
                        ],
                        "dimensionRows": [
                            [
                                "2020/06/01",
                                "上海",
                                "百度统计"
                            ],
                            [
                                "2020/06/02",
                                "上海",
                                "百度统计"
                            ],
                            [
                                "2020/06/03",
                                "上海",
                                "百度统计"
                            ]
                        ]
                    },
                    "totalData": {
                        "metricFields": [
                            {
                                "unit": "次",
                                "label": "任意事件的总次数(A)"
                            },
                            {
                                "unit": "%",
                                "label": "test(B)"
                            }
                        ],
                        "dimensionFields": [
                            "province_",
                            "keyword_"
                        ],
                        "metricRows": [
                            [
                                48356,
                                1.81
                            ]
                        ],
                        "dimensionRows": [
                            [
                                "上海",
                                "百度统计"
                            ]
                        ]
                    }
                }
            }
        ]
    }
}
  • 百度账号
{
    "result": {
        "detailData": {
            "dimensionFields": [
                "date_"
            ],
            "metricFields": [
                {
                    "label": "任意事件的总次数(A)",
                    "unit": "次"
                }
            ],
            "dimensionRows": [
                [
                    "2019/06/01"
                ],
                [
                    "2019/06/02"
                ],
                [
                    "2019/06/03"
                ]
            ],
            "metricRows": [
                [
                    1279820
                ],
                [
                    549456
                ],
                [
                    1234682
                ]
            ],
            "truncateCount": 6,
            "xAxis": [
                "2019/06/01",
                "2019/06/02",
                "2019/06/03"
            ]
        },
        "totalData": {
            "dimensionFields": [],
            "metricFields": [
                {
                    "label": "任意事件的总次数(A)",
                    "unit": "次"
                }
            ],
            "dimensionRows": [
                []
            ],
            "metricRows": [
                [
                    3063958
                ]
            ]
        }
    }
}