adi-analytics-api/api.tsp at main · adi-family/adi-analytics-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/**
 * Analytics API
 *
 * REST API for querying analytics metrics and dashboards.
 */

import "@typespec/http";

using TypeSpec.Http;

namespace AnalyticsApi;

// -- Models --

model DateRangeParams {
  @query startDate?: string;
  @query endDate?: string;
}

model OverviewStats {
  totalUsers: int64;
  activeUsersToday: int64;
  activeUsersWeek: int64;
  activeUsersMonth: int64;
  totalTasks: int64;
  tasksToday: int64;
  taskSuccessRate: float64;
  totalCocoons: int64;
  activeCocoons: int64;
  totalIntegrations: int64;
}

model DailyActiveUsers {
  day: utcDateTime;
  activeUsers: int64;
  totalEvents: int64;
}

model TaskStats {
  day: utcDateTime;
  created: int64;
  started: int64;
  completed: int64;
  failed: int64;
  cancelled: int64;
  avgDurationMs?: float64;
  p95DurationMs?: float64;
  successRate: float64;
}

model TaskStatsOverview {
  totalCreated: int64;
  totalCompleted: int64;
  totalFailed: int64;
  totalCancelled: int64;
  successRate: float64;
  avgDurationMs: float64;
}

model EndpointLatency {
  hour: utcDateTime;
  service: string;
  endpoint: string;
  method: string;
  requestCount: int64;
  avgDurationMs: float64;
  p50DurationMs: float64;
  p95DurationMs: float64;
  p99DurationMs: float64;
  error4xxCount: int64;
  error5xxCount: int64;
}

// -- Interface --

interface AnalyticsService {
  @get
  @route("/overview")
  getOverview(): {
    @statusCode statusCode: 200;
    @body body: OverviewStats;
  };

  @get
  @route("/users/daily")
  getDailyActiveUsers(...DateRangeParams): {
    @statusCode statusCode: 200;
    @body body: DailyActiveUsers[];
  };

  @get
  @route("/users/weekly")
  getWeeklyActiveUsers(...DateRangeParams): {
    @statusCode statusCode: 200;
    @body body: DailyActiveUsers[];
  };

  @get
  @route("/tasks/daily")
  getTaskStatsDaily(...DateRangeParams): {
    @statusCode statusCode: 200;
    @body body: TaskStats[];
  };

  @get
  @route("/tasks/overview")
  getTaskStatsOverview(...DateRangeParams): {
    @statusCode statusCode: 200;
    @body body: TaskStatsOverview;
  };

  @get
  @route("/api/latency")
  getEndpointLatency(...DateRangeParams): {
    @statusCode statusCode: 200;
    @body body: EndpointLatency[];
  };

  @get
  @route("/api/slowest")
  getSlowestEndpoints(): {
    @statusCode statusCode: 200;
    @body body: EndpointLatency[];
  };
}