aboutsummaryrefslogtreecommitdiffhomepage
path: root/packages/server-commands/src/videos/video-stats-command.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/server-commands/src/videos/video-stats-command.ts')
-rw-r--r--packages/server-commands/src/videos/video-stats-command.ts62
1 files changed, 62 insertions, 0 deletions
diff --git a/packages/server-commands/src/videos/video-stats-command.ts b/packages/server-commands/src/videos/video-stats-command.ts
new file mode 100644
index 000000000..1b7a9b592
--- /dev/null
+++ b/packages/server-commands/src/videos/video-stats-command.ts
@@ -0,0 +1,62 @@
1import { pick } from '@peertube/peertube-core-utils'
2import {
3 HttpStatusCode,
4 VideoStatsOverall,
5 VideoStatsRetention,
6 VideoStatsTimeserie,
7 VideoStatsTimeserieMetric
8} from '@peertube/peertube-models'
9import { AbstractCommand, OverrideCommandOptions } from '../shared/index.js'
10
11export class VideoStatsCommand extends AbstractCommand {
12
13 getOverallStats (options: OverrideCommandOptions & {
14 videoId: number | string
15 startDate?: string
16 endDate?: string
17 }) {
18 const path = '/api/v1/videos/' + options.videoId + '/stats/overall'
19
20 return this.getRequestBody<VideoStatsOverall>({
21 ...options,
22 path,
23
24 query: pick(options, [ 'startDate', 'endDate' ]),
25
26 implicitToken: true,
27 defaultExpectedStatus: HttpStatusCode.OK_200
28 })
29 }
30
31 getTimeserieStats (options: OverrideCommandOptions & {
32 videoId: number | string
33 metric: VideoStatsTimeserieMetric
34 startDate?: Date
35 endDate?: Date
36 }) {
37 const path = '/api/v1/videos/' + options.videoId + '/stats/timeseries/' + options.metric
38
39 return this.getRequestBody<VideoStatsTimeserie>({
40 ...options,
41 path,
42
43 query: pick(options, [ 'startDate', 'endDate' ]),
44 implicitToken: true,
45 defaultExpectedStatus: HttpStatusCode.OK_200
46 })
47 }
48
49 getRetentionStats (options: OverrideCommandOptions & {
50 videoId: number | string
51 }) {
52 const path = '/api/v1/videos/' + options.videoId + '/stats/retention'
53
54 return this.getRequestBody<VideoStatsRetention>({
55 ...options,
56 path,
57
58 implicitToken: true,
59 defaultExpectedStatus: HttpStatusCode.OK_200
60 })
61 }
62}