检索日志

分析允许您通过 API 查询在 BigQuery 中收集的数据。

准备¶

要使用数据查询 API，您必须通过 Hive 控制台 → 分析 → 日志定义菜单完成日志查询 API 的申请。申请完成后，将为您可以查询的日志发放 AccessKey 和 SecondAccessKey。AccessKey 和 SecondAccessKey 的功能相同，SecondAccessKey 是在 AccessKey 出现问题时发放的额外密钥。

※ AccessKey 和 SecondAccessKey 应保持机密，不得外泄。 ※ 如果 AccessKey 或 SecondAccessKey 被泄露，必须立即刷新或撤销。

如何申请数据查询开放API¶

在日志定义菜单中选择您想要发放 AccessKey 的游戏，然后点击您想要发放的日志名称以进入详细页面。点击“申请 OpenAPI”按钮，然后按“确认”按钮以发放密钥。

如何续订或撤销 AccessKey¶

在日志定义菜单中选择您要续订或撤销 AccessKey 的游戏，然后单击日志名称以进入详细页面。续订：单击“续订”按钮以发放新的 AccessKey，之前发放的 AccessKey 将变为不可用。撤销：单击“撤销”按钮以删除现有的 AccessKey，该密钥将不再可用。

常见的 API 信息¶

服务类型	域名
生产	analytics-openapi.com2us.com
沙盒	sandbox-analytics-openapi.com2us.com

必需的请求头参数：X-Analyitcs-Accesskey 您必须在请求头中包含此密钥值，以验证对OpenAPI数据查询的访问权限。

数据查询API¶

URL: https://{domain}/data/query/{logName}
描述：检索符合指定查询条件的数据。

请求 (POST, application/json)¶

名称	类型	必需	描述	示例
startDate	字符串	O	搜索开始时间（UTC格式：yyyy-MM-dd hh:mm:ss）（如果发送nextToken值，则必需：否）	2024-01-01 00:00:00
endDate	字符串	O	搜索结束时间（UTC格式：yyyy-MM-dd hh:mm:ss）（如果发送nextToken值，则必需：否）	2024-01-02 00:00:00
properties	JSON	X	JSON格式的搜索条件 {BigQuery字段名称: 搜索值, ...}	{"vid":123, "market":"A"}
QueryType	字符串	X	"0": 仅包含自定义字段，"1": 包含所有字段（默认值："0"）	"0"
nextPageToken	字符串	X	用于检索下一页数据的令牌值，每页返回20条数据，查询此值时不需要其他参数。	f3ebf4b6859a4f248b283a4fff1ded13

响应 (application/json)¶

名称	类型	描述	示例
totalRows	整数	搜索结果中的总行数	123
nextPageToken	字符串	用于检索下一页的令牌 * 如果是最后一页，则为null	f3ebf4b6859a4f248b283a4fff1ded13
datas	列表[JSON]	检索到的数据	[ { "dateTime": "2024-01-01T23:38:24Z", "vid": 123, "characterLv": 1 }, ... ]

请求示例¶

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/query/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"startDate": "2024-04-16 00:00:00",
"endDate": "2024-04-17 00:00:00"
}'

数据检查 API¶

URL: https://{domain}/data/check/{logName}
描述: 检查在过去一年中，是否存在符合搜索条件的日志在 BigQuery 中。

请求 (POST, application/json)¶

名称	类型	必需	描述	示例
properties	JSON	O	JSON 格式的搜索条件 {BigQuery 字段名称: 搜索值, ...}	{"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}

响应 (application/json)¶

名称	类型	描述	示例
isExists	布尔值	数据是否存在	true
datas	列表[JSON]	现有数据的最新 5 个示例值包括与搜索条件匹配的字段值以及 dateTime 和 guid 值。	[ { "vid": 123, "dateTime": "2024-04-16T23:09:24Z", "guid": "52e10350-fe3d-487f-8631-1dc640010c87" }, ... ]

请求示例¶

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/check/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"properties": {"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}
}'

错误代码¶

有关每个错误代码的详细信息，请参阅返回值中的详细消息。

40x: 访问密钥错误
- 访问密钥必须与您尝试查询的公司、游戏和日志名称的访问密钥匹配。如果发生此错误，您需要验证访问密钥是否正确。
50x: 系统错误
- 在数据检索和处理过程中发生的错误。
- 确保查询条件中的字段名称或值类型正确。
- 如果详细信息指示“系统错误”，表示未知错误，请稍后重试。