1- imports :
2- root : __package__.yml
1+ types :
2+ ApiProjectsDashboardRetrieveResponse :
3+ properties :
4+ annotated_tasks :
5+ type : optional<integer>
6+ docs : Number of annotated (completed) tasks
7+ annotations :
8+ type : optional<integer>
9+ docs : Total number of annotations
10+ remaining_tasks :
11+ type : optional<integer>
12+ docs : Total number of uncompleted tasks
13+ reviewed_tasks :
14+ type : optional<integer>
15+ docs : Number of tasks that have been reviewed by at least one reviewer
16+ skipped_tasks :
17+ type : optional<integer>
18+ docs : Number of tasks that have been skipped by at least one annotator
19+ tasks :
20+ type : optional<integer>
21+ docs : Total number of tasks
22+ source :
23+ openapi : openapi/openapi.yaml
24+ ApiProjectsDashboardMembersRetrieveResponseStatsItem :
25+ docs : User statistics
26+ properties :
27+ accepted :
28+ type : optional<integer>
29+ docs : Number of annotations marked as "Accepted" by reviewer
30+ finished :
31+ type : optional<integer>
32+ gt :
33+ type : optional<double>
34+ docs : Average agreement with Ground Truth annotations
35+ mean_time :
36+ type : optional<double>
37+ docs : Average mean time spent on annotation
38+ median_time :
39+ type : optional<double>
40+ docs : Average median time spent on annotation
41+ predictions :
42+ type : optional<double>
43+ docs : Average agreement with predictions
44+ progress :
45+ type : optional<integer>
46+ docs : Fraction of annotation work done so far
47+ rejected :
48+ type : optional<integer>
49+ docs : Number of annotations marked as "Rejected" by reviewer
50+ review_score :
51+ type : optional<double>
52+ docs : >-
53+ Average reviewing score, when calling with "per_label=true", returns
54+ dictionary with labels to score breakdown
55+ skipped :
56+ type : optional<integer>
57+ source :
58+ openapi : openapi/openapi.yaml
59+ inline : true
60+ ApiProjectsDashboardMembersRetrieveResponse :
61+ docs : Task creation response
62+ properties :
63+ similarity :
64+ type : optional<list<map<string, unknown>>>
65+ docs : Consensus statistics between different users
66+ stats :
67+ type : optional<list<ApiProjectsDashboardMembersRetrieveResponseStatsItem>>
68+ docs : Number of annotated (completed) tasks
69+ users :
70+ type : optional<list<map<string, unknown>>>
71+ docs : List of users
72+ source :
73+ openapi : openapi/openapi.yaml
374service :
475 auth : false
576 base-path : ' '
677 endpoints :
7- api_dashboards_kpis_retrieve :
8- path : /api/dashboards/{id}/kpis/{kpi_key}
9- method : GET
10- auth : true
11- docs : >-
12- Get Key Performance Indicator (KPI) data for a dashboard. Supports
13- various KPIs including: skipped_annotations, accepted_annotations,
14- rejected_annotations, average_time_per_task_min, total_annotations,
15- regions_created, and more.
16- source :
17- openapi : openapi/openapi.yaml
18- path-parameters :
19- id : integer
20- kpi_key : string
21- display-name : Get KPI data
22- request :
23- name : ApiDashboardsKpisRetrieveRequest
24- query-parameters :
25- end :
26- type : optional<string>
27- docs : End date for filtering (ISO format)
28- members :
29- type : optional<integer>
30- allow-multiple : true
31- docs : Array of user IDs to filter by
32- start :
33- type : optional<string>
34- docs : Start date for filtering (ISO format)
35- response :
36- docs : KPI data
37- type : map<string, unknown>
38- errors :
39- - root.NotFoundError
40- - root.NotImplementedError
41- examples :
42- - path-parameters :
43- id : 1
44- kpi_key : kpi_key
45- response :
46- body :
47- key : value
4878 api_projects_dashboard_retrieve :
4979 path : /api/projects/{id}/dashboard
5080 method : GET
@@ -70,6 +100,8 @@ service:
70100 reviewed_tasks : 1
71101 skipped_tasks : 1
72102 tasks : 1
103+ audiences :
104+ - internal
73105 api_projects_dashboard_members_retrieve :
74106 path : /api/projects/{id}/dashboard-members
75107 method : GET
@@ -135,78 +167,7 @@ service:
135167 skipped : 1
136168 users :
137169 - key : value
170+ audiences :
171+ - internal
138172 source :
139173 openapi : openapi/openapi.yaml
140- types :
141- ApiProjectsDashboardRetrieveResponse :
142- properties :
143- annotated_tasks :
144- type : optional<integer>
145- docs : Number of annotated (completed) tasks
146- annotations :
147- type : optional<integer>
148- docs : Total number of annotations
149- remaining_tasks :
150- type : optional<integer>
151- docs : Total number of uncompleted tasks
152- reviewed_tasks :
153- type : optional<integer>
154- docs : Number of tasks that have been reviewed by at least one reviewer
155- skipped_tasks :
156- type : optional<integer>
157- docs : Number of tasks that have been skipped by at least one annotator
158- tasks :
159- type : optional<integer>
160- docs : Total number of tasks
161- source :
162- openapi : openapi/openapi.yaml
163- ApiProjectsDashboardMembersRetrieveResponseStatsItem :
164- docs : User statistics
165- properties :
166- accepted :
167- type : optional<integer>
168- docs : Number of annotations marked as "Accepted" by reviewer
169- finished :
170- type : optional<integer>
171- gt :
172- type : optional<double>
173- docs : Average agreement with Ground Truth annotations
174- mean_time :
175- type : optional<double>
176- docs : Average mean time spent on annotation
177- median_time :
178- type : optional<double>
179- docs : Average median time spent on annotation
180- predictions :
181- type : optional<double>
182- docs : Average agreement with predictions
183- progress :
184- type : optional<integer>
185- docs : Fraction of annotation work done so far
186- rejected :
187- type : optional<integer>
188- docs : Number of annotations marked as "Rejected" by reviewer
189- review_score :
190- type : optional<double>
191- docs : >-
192- Average reviewing score, when calling with "per_label=true", returns
193- dictionary with labels to score breakdown
194- skipped :
195- type : optional<integer>
196- source :
197- openapi : openapi/openapi.yaml
198- inline : true
199- ApiProjectsDashboardMembersRetrieveResponse :
200- docs : Task creation response
201- properties :
202- similarity :
203- type : optional<list<map<string, unknown>>>
204- docs : Consensus statistics between different users
205- stats :
206- type : optional<list<ApiProjectsDashboardMembersRetrieveResponseStatsItem>>
207- docs : Number of annotated (completed) tasks
208- users :
209- type : optional<list<map<string, unknown>>>
210- docs : List of users
211- source :
212- openapi : openapi/openapi.yaml
0 commit comments