OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
model_name | String | Required | Your table Model Name | ||
op | Enum | Optaion | COUNT | Range: SUM/COUNT | 需要统计的类型,求和:SUM,算总条目数:COUNT |
field | String | Required | 需要统计的字段,如:field=money | ||
date_field | String | Required | add_time | 需要统计的时间日期字段,此字段类型必须是datetime,如:field=add_time | |
days | Int | Optaion | 7 | MAX: 180 | 多少天前的对比报表数据,例如7表示一周前,30天表示上个月 |
startDate | Date | Optaion | 开始日期,例如:2020-02-20 | ||
endDate | Date | Optaion | 结束日期,例如:2020-02-27,包含结束当天的数据。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
model_name | *Required | |
op | Option | |
field | *Required | |
date_field | *Required | |
days | Option | |
startDate | Option | |
endDate | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
items | Object | 报表数据 |
items.now | Array | 最近几天的统计数据 |
items.now[].id | Int | 序号 |
items.now[].date | String | 日期,格式如:2019-04-01 |
items.now[].total | Float | 统计的总数 |
items.pre | Array | 上一周期的统计数据 |
items.pre[].id | Int | 序号 |
items.pre[].date | String | 日期,格式如:2019-04-01 |
items.pre[].total | Float | 统计的总数 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |