bShare Analytics API 提供了bShare Pro用户可编程的分享数据访问服务。
请求链接
请求方法
GET
认证方法
需要通过HTTP BASIC Authentication方式进行认证。使用该UUID所有者在bShare网站的用户名和密码即可。
路径参数
以下所有的路径参数都为必需
| publisherUUID | 您需要获取统计数据的站点的publisher UUID. |
| metric | 您想获得的统计类型. 可使用的参数有: click | share | clickback | platform stats. Metrics说明 platform: 返回前10位的分享平台数据。包括分享总数和平台名称。 |
| platform_b | 返回前10位的分享平台数据。包括回流总数和平台名称。 |
| stats | 返回点击数、分享数和回流数及日期 |
| click | 返回点击数和日期。 |
| share | 返回分享数和日期。 |
| clickback | 返回回流数和日期。 |
查询参数
所有的查询参数都为可选。请注意：如果您未设置该参数，我们将按照下面罗列出的默认值提供查询结果。
| dateStart | 您想查询数据的起始日期 (含该日)。该日期值必须为以下格式: yyyy-mm-dd. 如果没有设置该值或者被设定为无效的值， dateStart将默认为今天。 |
| dateEnd | 您想查询数据的终止日期 (含该日)。该日期必须为以下格式: yyyy-mm-dd. 如果没有设置该值或者被设定为无效的值, dateEnd将默认为dateStart之前7天. |
| url | 使用此参数来查询指定页面的数据，注意页面url必须是完全匹配，并且此页面必须属于当前站长。 |
| locale | 返回数据的语言。可使用的值有 zh | zh_TW | en。 如果没有设置该值或者设定为无效的值，locale将默认为中文(zh). |
请求限制
所有的API限制请求数为1000次/每小时。
请求返回
如果出错，返回对应的HTTP状态码及错误信息；否则，HTTP状态码为200，并返回JSON格式的数据。
请求的metric为platform:
请求的metric为platform_b:
请求的metric为share/click/clickback:
请求的metric为stats:
