paricafe/src/server/api/endpoints/charts/users.ts

38 lines
924 B
TypeScript
Raw Normal View History

2018-10-20 19:20:11 -05:00
import $ from 'cafy';
2018-11-01 23:47:44 -05:00
import define from '../../define';
2019-02-23 21:23:31 -06:00
import usersChart, { usersLogSchema } from '../../../../services/chart/users';
import { convertLog } from '../../../../services/chart';
2018-10-20 19:20:11 -05:00
export const meta = {
2018-11-28 15:06:07 -06:00
stability: 'stable',
2018-10-20 19:20:11 -05:00
desc: {
2018-10-22 15:36:35 -05:00
'ja-JP': 'ユーザーのチャートを取得します。'
2018-10-20 19:20:11 -05:00
},
tags: ['charts', 'users'],
2018-10-20 19:20:11 -05:00
params: {
2018-11-01 13:32:24 -05:00
span: {
validator: $.str.or(['day', 'hour']),
2018-10-20 19:20:11 -05:00
desc: {
2018-10-22 03:06:53 -05:00
'ja-JP': '集計のスパン (day または hour)'
2018-10-20 19:20:11 -05:00
}
2018-11-01 13:32:24 -05:00
},
2018-10-20 19:20:11 -05:00
2018-11-01 13:32:24 -05:00
limit: {
2019-02-13 01:33:07 -06:00
validator: $.optional.num.range(1, 500),
2018-10-20 19:20:11 -05:00
default: 30,
desc: {
'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
}
2018-11-01 13:32:24 -05:00
},
},
2019-02-23 21:23:31 -06:00
res: convertLog(usersLogSchema),
2018-10-20 19:20:11 -05:00
};
export default define(meta, async (ps) => {
return await usersChart.getChart(ps.span as any, ps.limit);
});