API 文档

了解如何连接和集成我们的 API。

 

认证

所有 API 端点都需要通过 Bearer 认证方法发送 API 密钥。

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://analytics.ospyo.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

错误

我们的 API 使用传统的 HTTP 状态码来指示请求的成功或失败。

{
    "errors": [
        {
            "title": "\u60a8\u65e0\u6743\u8bbf\u95ee API\u3002",
            "status": 401
        }
    ]
}
200 请求成功完成
400 错误请求 - 必需参数缺失或无效
401 未授权 - API 密钥缺失或无效
404 未找到请求的资源
429 请求过多 - 超出速率限制
500 内部服务器错误 - 这意味着我们这边出现了问题
所有 API 端点结果默认使用 UTC 时区,除非另有说明。
用户
网站
页面浏览
访客
目标
目标转化
网站统计
账户日志