misskey/src/server/api/endpoints/charts/notes.ts

import $ from 'cafy';
import define from '../../define';
import { convertLog } from '../../../../services/chart/core';
import { notesChart } from '../../../../services/chart';

export const meta = {
	desc: {
		'ja-JP': '投稿のチャートを取得します。'
	},

	tags: ['charts', 'notes'],

	params: {
		span: {
			validator: $.str.or(['day', 'hour']),
			desc: {
				'ja-JP': '集計のスパン (day または hour)'
			}
		},

		limit: {
			validator: $.optional.num.range(1, 500),
			default: 30,
			desc: {
				'ja-JP': '最大数。例えば 30 を指定したとすると、スパンが"day"の場合は30日分のデータが、スパンが"hour"の場合は30時間分のデータが返ります。'
			}
		},

		offset: {
			validator: $.optional.nullable.num,
			default: null,
		},
	},

	res: convertLog(notesChart.schema),
};

export default define(meta, async (ps) => {
	return await notesChart.getChart(ps.span as any, ps.limit!, ps.offset ? new Date(ps.offset) : null);
});