埋点统计 API (ver >=1.12) · 神策分析使用手册[预览版]

埋点统计 API Ver >= 1.12

最后更新于：2019-01-05 17:04:39

1 获取埋点来源

[GET /data_source/category]

使用该 API 获取当前埋点数据(一般只有最近7天的数据)的来源信息：APP 版本号、导入方式。

后续可以根据来源信息获取指定 APP 版本和指定导入方式的埋点报告信息。

Request GET /data_source/category
Response 200 (application/json)

{
    "lib":[             // 导入方式
        "python",
        "LogAgent"
    ],
    "app_version":[     // APP 版本号
        "1.0",
        "1.1",
        "2.0",
        "2.1",
        "1.2"
    ]
}

2 获取埋点统计报告

[POST /data_source/report]

使用该 API 可以获取埋点统计报告。一般情况下，埋点数据仅保存最近 7 天数据。

若不指定查询区间，默认查询最近 1 小时的埋点统计。查询的运行时间与查询区间正相关，请合理配置查询区间，不要设置过大。

出现已导入大于已读取有可能是正常的，因为这是不同模块的统计结果，有可能这段时间没有读取和校验数据，但另一个模块正在导入之前校验成功的数据。

埋点统计的时间是实际进行导入的时间，如今天导入了前天的一条数据，这条数据会被统计到今天的报告里。

Request (application/json)

{
    "from":"1527056400000",        // 查询时间区间开始时间
    "to":"1532499600000",        // 查询时间区间结束时间
    "app_version":"all",        // 埋点数据来源的 APP 版本号，"all" 查所有
    "status":"storage",            // 埋点数据的状态，"storage" = 已入库; "error" = 包含错误
    "lib":"python"                //     埋点数据的导入方式
}

Response 200 (application/json)

{
    "read_update_time":1481711426000,    // 上次更新读取条数时间
    "read":194,                          // 项目一共读取条数
    "send_update_time":1481711426000,    // 上次更新发送条数时间
    "send":192,                          // 项目一共发送条数
    "write_update_time":1481711407000,   // 上次更新导入条数时间
    "write":192,                         // 项目一共导入条数
    "detail_last":1481711426000,         // 详情更新时间
    "detail":{
        "read":19775,                     // 符合筛选条件的读取条数
        "send":19775,                     // 符合筛选条件的发送条数
        "write":19775,                     // 符合筛选条件的入库条数
        "err":0,                         // 符合筛选条件的错误条数
        "payload":[                         // 根据事件分类的详细信息
            {
                "event":"taskOperation",
                "read":961,
                "send":961,
                "write":961,
                "err":0,
                "last":0,
                "payload":[                 // 事件的详细来源信息
                    {
                        "lib":"python",
                        "lib_version":"1.7.1",
                        "app_version":"2.0",
                        "lib_method":"code",
                        "lib_detail":"normal_mode##normal_mode##simulator.py##582",
                        "read":961,
                        "send":961,
                        "write":961,
                        "err":0,
                        "last":0
                    }
                ]
            }
        ]
    }
}