Skip to content

Commit f27be99

Browse files
committed
update api
1 parent 49f71ba commit f27be99

File tree

1 file changed

+78
-2
lines changed

1 file changed

+78
-2
lines changed

doc/api.md

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,47 @@ PATH:`GET /api/v1/traffic/views/`
198198
}
199199
```
200200

201-
### 3.2 获取推荐项目点击详细数据
201+
202+
### 3.2 获取推荐项目点击统计图数据
203+
204+
推荐项目点击统计数据用于图表展示。(折线图)
205+
206+
PATH:`GET /api/v1/traffic/click/view/`
207+
208+
参数:
209+
210+
| 名称 | 必须 | 类型 | 描述 |
211+
| ------- | ----- | ----- | ----- |
212+
| start_time || int | 开始时间戳 |
213+
| end_time || int | 结束时间戳 |
214+
215+
响应:
216+
```
217+
{
218+
"message": "OK",
219+
"payload": {
220+
"start_time": 1573713003,
221+
"end_time": 1573723003,
222+
"per": "hour", #时间聚合的维度分:day和hour
223+
"all_count": 400, #该时间段的总数
224+
"all_ip_count": 322, #IP总数
225+
"data": [
226+
{
227+
"category_id": 1,
228+
"category_name": "Python 项目",
229+
"timestamp": "1573713003", #时间
230+
"count": 440, #某一时间段项目的点击数量
231+
"ip_count": 322 # IP数量
232+
},
233+
...
234+
]
235+
}
236+
]
237+
}
238+
}
239+
```
240+
241+
### 3.3 获取推荐项目点击详细数据
202242

203243
返回推荐项目点击统计列表的数据
204244

@@ -247,8 +287,44 @@ PATH:`GET /api/v1/traffic/click/detail/`
247287
}
248288
}
249289
```
290+
### 3.4 获取某一期月刊的统计图数据
291+
292+
某一期月刊的统计数据用于图表展示。(双条形图)
293+
294+
PATH:`GET /api/v1/traffic/periodical/view/`
295+
296+
参数:
297+
298+
| 名称 | 必须 | 类型 | 描述 |
299+
| ------- | ----- | ----- | ----- |
300+
| volume_id || int | 期刊的 id,默认为最新一期 |
301+
| category_id || int | 期刊分类的 id,默认返回所有分类的数据|
302+
303+
响应:
304+
```
305+
{
306+
"message": "OK",
307+
"payload": {
308+
"all_count": 400, #该时间段的总数
309+
"all_ip_count": 322, #IP总数
310+
"data": [
311+
{
312+
"category_id": 1,
313+
"category_name": "Python 项目",
314+
"volume_id": 1,
315+
"volume_name": "01",
316+
"count": 440, #某一时间段项目的点击数量
317+
"ip_count": 322 # IP数量
318+
},
319+
...
320+
]
321+
}
322+
]
323+
}
324+
}
325+
```
250326

251-
### 3.3 获取某一期月刊的详细数据
327+
### 3.5 获取某一期月刊的详细数据
252328

253329
某一期月刊的统计数据用于列表的数据。
254330

0 commit comments

Comments
 (0)