秒针分析统计数据API接入指南

1、接口概述

API可助您自动完成复杂的报告任务。您可以使用API查询维度和指标，以创建所需的报告。API返回的报告数据源于跟踪代码收集到的数据的统计。

2、接口接入流程

STEP 1：获取token

登录秒针分析系统界面，在设置-项目设置-报表API中获取当前站点对应的站点token，在设置-项目设置-项目API中可获取当前项目对应的项目Token。

STEP 2：拼接简单的维度指标进行请求

根据3、接口说明部分拼接必要的参数进行接口请求。

STEP 3：请求成功后，接口初步接入完成

STEP2能够正确获取数据后，可根据实际业务需求调整维度、指标、过滤条件等参数实现实际业务场景下对应统计数据的获取。

3、接口说明

方式一：单站点，通过站点鉴权

GET: tongji.cn.miaozhen.com/query/stat

在接口地址后拼接参数传入，其中token也可在Get请求的header部分以k:v形式传入

请求参数

请求示例

Python:

import requests
import json

# API地址
api_url = "https://tongji.cn.miaozhen.com/query/stat"
# 使用python的requests库拼接请求
resp = requests.get(
    api_url,
    params={
        # 站点ID为2164
        'SiteId': '2164',
        # 视图ID为2442
        'ViewId': '2442',
        # 站点token为216425be71c94de7a7f929339701
        'token':'216425be71c94de7a7f929339701',
        # 查询起始时间为2021-08-18 00:00:00 - 2021-08-18 23:59:59
        'begindate': '1629216000',
        'enddate': '1629302399',
        # 查询维度为日期、小时
        'dims': 'date,hour',
        # 指标为会话数、浏览量、用户数、平均会话时长、跳出率、每次会话浏览量
        'metrics': 'sessions,pageviews,users,avg_session,bounce_rate,pageviews_session',
        # 按照会话数倒序排序
          "sort": "sessions|-1",
          # 筛选条件为日期等于2021年8月18日
          'condition': "{'date':{'$in':['20210818']}}",
          # 筛选条件传原值
          'isOriginal':'1'
}
)

# Json转化为字典
resp_dict = json.loads(resp.text)

# 输出返回结果
resp_dict

接口返回

返回格式为JSON格式。

返回信息示例

{
    "success": true, //是否成功
    "message": "success",  //错误信息
    "result": {
    /* 
    result中属性含义
        total:查询结果总条数，超过50000条时会返回50000，API单次查询最多支持5w条。
        amount:各个指标的汇总值。
        debug:是否调试模式（无需关注）。
        size:本次返回的条数，和limit值有关。
        page:当前查询到第几页，如10000条数据，limit 1000进行查询，每一页返回1000，通过更改page属性的值可以实现翻页。循环10次后能够获取完整数据。
        items:查询结果的明细记录。
    */
        "total": 2, 
        "amount": {
            "total": 1, 
            "sessions": 4, 
            "pageviews": 19, 
            "avg_session": 264.5, 
            "bounce_rate": 0, 
            "pageviews_session": 4.75, 
            "users": 4
        }, 
        "debug": null, 
        "size": 1000, 
        "page": 1, 
        "items": [
            {
                "date": "20210818", 
                "sessions": 2, 
                "pageviews": 7, 
                "avg_session": 209.5, 
                "hour": "18:00 ~ 18:59", 
                "_hour": "18", 
                "bounce_rate": 0, 
                "pageviews_session": 3.5, 
                "id": 1, 
                "users": 2
            }, 
            {
                "date": "20210818", 
                "sessions": 2, 
                "pageviews": 12, 
                "avg_session": 319.5, 
                "hour": "19:00 ~ 19:59", 
                "_hour": "19", 
                "bounce_rate": 0, 
                "pageviews_session": 6, 
                "id": 2, 
                "users": 2
            }
        ]
    }
}

方式二：多站点，通过项目鉴权

GET: tongji.cn.miaozhen.com/query/stat

在接口地址后拼接参数传入，其中projectToken也可在Get请求的header部分以k:v形式传入

请求参数

请求示例

Python:

import requests
import json

# API地址
api_url = "https://tongji.cn.miaozhen.com/query/stat"
# 使用python的requests库拼接请求
resp = requests.get(
    api_url,
    params={
        # 项目ID为441
        'projectId': '441',
        # projectToken为4417907a9410a8a923c32293311
        'projectToken':'4417907a9410a8a923c32293311',
          #方式A：不传SiteId,siteViews,siteType, 获取项目下全部站点默认视图的数据

          #方式B：传siteViews如下,查询项目下2164站点2442视图和3162站点3502视图的数据
          #'siteViews': '[{"siteId":2164,"viewId":2442}, {"siteId":3162,"viewId":3502}]', 

          #方式C：传SiteId如下，查询项目下2164和3162站点下默认视图的数据
          #'SiteId': '2164,3162', 

        #方式D：传siteType如下,查询项目下全部Web站点下默认视图的数据
          #'siteType': '0', 

          #注意：方式B，C，D互斥， siteViews，SiteId，siteType 不能同时传值

          # 查询起始时间为2021-08-18 00:00:00 - 2021-08-18 23:59:59
        'begindate': '1629216000',
        'enddate': '1629302399',
        # 查询维度为日期、小时
        'dims': 'date,hour',
        # 指标为会话数、浏览量、用户数、平均会话时长、跳出率、每次会话浏览量
        'metrics': 'sessions,pageviews,users,avg_session,bounce_rate,pageviews_session',
        # 按照会话数倒序排序
          "sort": "sessions|-1",
          # 筛选条件为日期等于2021年8月18日
          'condition': "{'date':{'$in':['20210818']}}",
          # 筛选条件传原值
          'isOriginal':'1'
}
)

# Json转化为字典
resp_dict = json.loads(resp.text)

# 输出返回结果
resp_dict

接口返回

返回格式为JSON格式。

返回信息示例

{
    "success": true, //是否成功
    "message": "success",  //错误信息
    "result": {
      /*result中属性含义
                  total：查询结果总条数，超过50000条时会返回50000，API单次查询最多支持5w条。
                  amount：各个指标的汇总值。
                  debug：是否调试模式。
                  size：本次返回的条数，和limit值有关。
                  page：当前查询到第几页，如10000条数据，limit 1000进行查询，每一页返回1000，通过更改page属性的值可以实现翻页。循环10次后能够获取完整数据。
                  items：查询结果的明细记录。
     */
            "total": 2, 
            "amount": {
                "total": 1, 
                "sessions": 4, 
                "pageviews": 19, 
                "avg_session": 264.5, 
                "bounce_rate": 0, 
                "pageviews_session": 4.75, 
                "users": 4
            }, 
          "size": 1000, 
          "page": 1, 
          "items": [
                {
                "siteId";2164,
                "viewId":2442,
                  "date": "20210818", 
                  "hour": "18:00 ~ 18:59", 
                "sessions": 2, 
                "pageviews": 7, 
                "avg_session": 209.5, 
                "_hour": "18", 
                "bounce_rate": 0, 
                "pageviews_session": 3.5, 
                "id": 1, 
                "users": 2
                }, 
                 {
                "siteId";3162,
                "viewId":3502,
                "avg_session": 319.5, 
                "date": "20210818", 
                "hour": "19:00 ~ 19:59",
                "sessions": 2, 
                "pageviews": 12, 
                "_hour": "19", 
                "bounce_rate": 0, 
                "pageviews_session": 6, 
                "id": 2, 
                "users": 2
             }
         ]
    }
}

附录

通用维度指标

秒针分析系统涉及的维度指标较多，现列举部分常用字段及其定义。

注意：

1、维度指标不能随意组合，组合的维度指标需正确且有意义。可先基于系统【自定义探索】模块中【访问分析】、【页面分析】、【事件分析】下的维度指标组合为参考。

2、广告相关指标（如点击/曝光）涉及联表查询，数据库性能限制暂不支持API获取。

3、凡是字段带前缀“_”的，都为系统用于反查文字信息的字段，无实际业务意义。

1、维度

时间维度

地理特征维度

设备维度

客户端维度

秒针广告维度

谷歌广告维度

自定义广告维度

搜索引擎维度

社交媒体维度

其他来源维度

页面与事件维度

自定义事件类维度

用户特征维度

自定义维度

受访频道类维度

2、指标

基础数据类指标

页面与事件指标

自定义事件类指标

计算指标类指标

目标类指标

自定义指标类指标

虚拟指标类指标

condition条件表达式