OkayAPI Docs


API Path: /api/App/Partner_Counter/RankList

API Description: 根据不同的计数器类型,获取当前周期的排行榜。例如小时的日排行榜、日的月排行榜、周的年排行榜、月的年排行榜、年的全部排序榜、永久的永久排行榜。向上一级取更大时间范围的排行榜。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringRequiredMIN: 32;MAX: 32UUID,全局唯一用户ID
tokenStringRequiredMIN: 64;MAX: 64会话凭证
typeEnumRequiredRange: hour/day/week/month/year/forever计数器类型,时/日/周/月/年/永久计数器
nameStringOptaionMIN: 1;MAX: 64计数器名称,支持模糊匹配,为空时取全部
other_uuidStringRequiredMIN: 32;MAX: 32已登录用户针对的其他用户的ID
numIntOptaion100排行榜前面多少个
start_timeStringOptaion开始时间,未指定时取当前相应的时间周期,示例:2020-05-14 14:29:12

API Debug

KEYREQUIREDVALUE
app_key *Required
uuid *Required
token *Required
type *Required
name Option
other_uuid *Required
num Option
start_time Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error