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

42 lines
877 B
TypeScript
Raw Normal View History

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