@rundit-sdk/embed 0.3.0-rc.13 → 0.3.0-rc.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/openapi.json CHANGED
@@ -1,6 +1,144 @@
1
1
  {
2
2
  "openapi": "3.0.0",
3
3
  "paths": {
4
+ "/api/v2/sdk/companies/dashboards": {
5
+ "post": {
6
+ "description": "PREFERRED tool for multi-company analysis. Returns full dashboards (company metadata, positions, metrics with data points, recent transactions, report summaries) for many companies in a single request, grouped per company. Use this instead of looping `GET /companies/:id/dashboard` (the N+1 pattern) whenever the agent needs to look at more than one company — it returns the same shape per company but in one round trip. Typical workflow: resolve company ids (e.g. `GET /companies?nameSearch=[\"acme\",\"beta\"]`), then call this with their `companyIds`. Use `metricTypeIds` or `metricTypeNames` to scope the returned metrics, `metricsTimeframe` to restrict data point granularity, `currency` (ISO 4217) to FX-convert monetary metrics across the batch, and `transactionLimit` / `reportLimit` to cap list sizes per company.",
7
+ "operationId": "companies.getDashboards",
8
+ "parameters": [],
9
+ "requestBody": {
10
+ "required": true,
11
+ "content": {
12
+ "application/json": {
13
+ "schema": {
14
+ "$ref": "#/components/schemas/GetBatchDashboardBodyDto"
15
+ }
16
+ }
17
+ }
18
+ },
19
+ "responses": {
20
+ "200": {
21
+ "description": "",
22
+ "content": {
23
+ "application/json": {
24
+ "schema": {
25
+ "$ref": "#/components/schemas/SdkBatchDashboardResponseDto"
26
+ }
27
+ }
28
+ }
29
+ },
30
+ "401": {
31
+ "description": "Missing or invalid SDK credentials"
32
+ }
33
+ },
34
+ "security": [
35
+ {
36
+ "sdk-embed-token": []
37
+ },
38
+ {
39
+ "sdk-client-api-key": []
40
+ }
41
+ ],
42
+ "summary": "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call",
43
+ "tags": [
44
+ "sdk-companies"
45
+ ],
46
+ "x-sdk-audiences": [
47
+ "embed",
48
+ "client"
49
+ ],
50
+ "x-sdk-namespace": "companies",
51
+ "x-sdk-operation": "getDashboards"
52
+ }
53
+ },
54
+ "/api/v2/sdk/companies/{id}/dashboard": {
55
+ "get": {
56
+ "description": "Returns company metadata, positions per fund, all metrics with data points, recent transactions, and report summaries for a single company. For more than one company, prefer POST /companies/dashboards (`companies.getDashboards`) instead — it returns the same payload per company in one call and avoids the N+1 pattern. Use `metricsFrom` to limit metric history, `transactionLimit` and `reportLimit` to cap list sizes.",
57
+ "operationId": "companies.getDashboard",
58
+ "parameters": [
59
+ {
60
+ "name": "id",
61
+ "required": true,
62
+ "in": "path",
63
+ "description": "Company identifier",
64
+ "schema": {
65
+ "type": "number"
66
+ }
67
+ },
68
+ {
69
+ "name": "currency",
70
+ "required": true,
71
+ "in": "query",
72
+ "description": "Reporting currency code (ISO 4217).",
73
+ "schema": {
74
+ "type": "string"
75
+ }
76
+ },
77
+ {
78
+ "name": "metricsFrom",
79
+ "required": false,
80
+ "in": "query",
81
+ "description": "Lower bound for metric data points (ISO 8601). Omit to include all available history.",
82
+ "schema": {
83
+ "type": "string"
84
+ }
85
+ },
86
+ {
87
+ "name": "transactionLimit",
88
+ "required": false,
89
+ "in": "query",
90
+ "description": "Maximum number of transactions to include (most recent first). Defaults to 10.",
91
+ "schema": {
92
+ "default": 10,
93
+ "type": "number"
94
+ }
95
+ },
96
+ {
97
+ "name": "reportLimit",
98
+ "required": false,
99
+ "in": "query",
100
+ "description": "Maximum number of reports to include (most recent first). Defaults to 5.",
101
+ "schema": {
102
+ "default": 5,
103
+ "type": "number"
104
+ }
105
+ }
106
+ ],
107
+ "responses": {
108
+ "200": {
109
+ "description": "",
110
+ "content": {
111
+ "application/json": {
112
+ "schema": {
113
+ "$ref": "#/components/schemas/SdkCompanyDashboardDto"
114
+ }
115
+ }
116
+ }
117
+ },
118
+ "401": {
119
+ "description": "Missing or invalid SDK credentials"
120
+ }
121
+ },
122
+ "security": [
123
+ {
124
+ "sdk-embed-token": []
125
+ },
126
+ {
127
+ "sdk-client-api-key": []
128
+ }
129
+ ],
130
+ "summary": "Get full company dashboard for ONE company",
131
+ "tags": [
132
+ "sdk-companies"
133
+ ],
134
+ "x-sdk-audiences": [
135
+ "embed",
136
+ "client"
137
+ ],
138
+ "x-sdk-namespace": "companies",
139
+ "x-sdk-operation": "getDashboard"
140
+ }
141
+ },
4
142
  "/api/v2/sdk/companies/{id}": {
5
143
  "get": {
6
144
  "operationId": "companies.getOne",
@@ -52,6 +190,7 @@
52
190
  },
53
191
  "/api/v2/sdk/companies": {
54
192
  "get": {
193
+ "description": "Returns the compact form (id, name, currency, type, website, logo) for every company the caller can read. Filter by `companyIds`, `companyGroupIds`, and/or `nameSearch` (case-insensitive substring on display name; accepts an array to resolve multiple companies at once with OR semantics — e.g. `nameSearch=[\"acme\",\"beta\",\"gamma\"]` returns any company whose name contains any of the three substrings). Avoids listing the full portfolio when the agent only knows companies by name.",
55
194
  "operationId": "companies.getAll",
56
195
  "parameters": [
57
196
  {
@@ -95,6 +234,18 @@
95
234
  "type": "number"
96
235
  }
97
236
  }
237
+ },
238
+ {
239
+ "name": "nameSearch",
240
+ "required": false,
241
+ "in": "query",
242
+ "description": "Case-insensitive substring match on company display name. Pass an array to resolve multiple companies in one call — a company matches if its name contains ANY of the listed substrings (OR semantics). Combine with companyIds/companyGroupIds to find specific companies without first listing the entire portfolio.",
243
+ "schema": {
244
+ "type": "array",
245
+ "items": {
246
+ "type": "string"
247
+ }
248
+ }
98
249
  }
99
250
  ],
100
251
  "responses": {
@@ -134,6 +285,7 @@
134
285
  },
135
286
  "/api/v2/sdk/company-groups": {
136
287
  "get": {
288
+ "description": "Returns compact company group metadata (id, name, demo flag, color, member company ids). Filter by `companyGroupIds` and/or `nameSearch` (case-insensitive substring on name; accepts an array to resolve multiple groups in one call with OR semantics — e.g. `nameSearch=[\"fund i\",\"fund ii\"]`).",
137
289
  "operationId": "companyGroups.getAll",
138
290
  "parameters": [
139
291
  {
@@ -165,6 +317,18 @@
165
317
  "type": "number"
166
318
  }
167
319
  }
320
+ },
321
+ {
322
+ "name": "nameSearch",
323
+ "required": false,
324
+ "in": "query",
325
+ "description": "Case-insensitive substring match on company group display name. Pass an array to resolve multiple groups in one call — a group matches if its name contains ANY of the listed substrings (OR semantics). Useful for finding funds or visibility groups by name without first listing all groups.",
326
+ "schema": {
327
+ "type": "array",
328
+ "items": {
329
+ "type": "string"
330
+ }
331
+ }
168
332
  }
169
333
  ],
170
334
  "responses": {
@@ -251,6 +415,119 @@
251
415
  "x-sdk-operation": "getOne"
252
416
  }
253
417
  },
418
+ "/api/v2/sdk/positions/portfolio/summary": {
419
+ "get": {
420
+ "description": "Returns one row per company with position data (invested, fair value, multiple, ROI) and latest values for selected metrics. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Override with `metricTypeNames`. Designed for portfolio overview tables.",
421
+ "operationId": "positions.getPortfolioSummary",
422
+ "parameters": [
423
+ {
424
+ "name": "limit",
425
+ "required": false,
426
+ "in": "query",
427
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
428
+ "schema": {
429
+ "type": "number"
430
+ }
431
+ },
432
+ {
433
+ "name": "cursor",
434
+ "required": false,
435
+ "in": "query",
436
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
437
+ "schema": {
438
+ "type": "string"
439
+ }
440
+ },
441
+ {
442
+ "name": "companyGroupIds",
443
+ "required": false,
444
+ "in": "query",
445
+ "description": "Restrict to companies that belong to any of these company groups.",
446
+ "schema": {
447
+ "type": "array",
448
+ "items": {
449
+ "type": "number"
450
+ }
451
+ }
452
+ },
453
+ {
454
+ "name": "companyIds",
455
+ "required": false,
456
+ "in": "query",
457
+ "description": "Restrict to these company identifiers.",
458
+ "schema": {
459
+ "type": "array",
460
+ "items": {
461
+ "type": "number"
462
+ }
463
+ }
464
+ },
465
+ {
466
+ "name": "currency",
467
+ "required": true,
468
+ "in": "query",
469
+ "description": "Reporting currency code (ISO 4217).",
470
+ "schema": {
471
+ "type": "string"
472
+ }
473
+ },
474
+ {
475
+ "name": "date",
476
+ "required": false,
477
+ "in": "query",
478
+ "description": "Position summary date (ISO 8601). Defaults to today.",
479
+ "schema": {
480
+ "type": "string"
481
+ }
482
+ },
483
+ {
484
+ "name": "metricTypeNames",
485
+ "required": false,
486
+ "in": "query",
487
+ "description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway.",
488
+ "schema": {
489
+ "type": "array",
490
+ "items": {
491
+ "type": "string"
492
+ }
493
+ }
494
+ }
495
+ ],
496
+ "responses": {
497
+ "200": {
498
+ "description": "",
499
+ "content": {
500
+ "application/json": {
501
+ "schema": {
502
+ "$ref": "#/components/schemas/SdkPortfolioSummaryListResponseDto"
503
+ }
504
+ }
505
+ }
506
+ },
507
+ "401": {
508
+ "description": "Missing or invalid SDK credentials"
509
+ }
510
+ },
511
+ "security": [
512
+ {
513
+ "sdk-embed-token": []
514
+ },
515
+ {
516
+ "sdk-client-api-key": []
517
+ }
518
+ ],
519
+ "summary": "Get portfolio summary with positions and key metrics per company",
520
+ "tags": [
521
+ "sdk-positions"
522
+ ],
523
+ "x-sdk-audiences": [
524
+ "embed",
525
+ "client"
526
+ ],
527
+ "x-sdk-namespace": "positions",
528
+ "x-sdk-operation": "getPortfolioSummary"
529
+ }
530
+ },
254
531
  "/api/v2/sdk/positions/companies/{id}": {
255
532
  "get": {
256
533
  "operationId": "positions.getCompanyPositions",
@@ -430,19 +707,11 @@
430
707
  "x-sdk-operation": "getPortfolioPositions"
431
708
  }
432
709
  },
433
- "/api/v2/sdk/transactions/companies/{id}": {
710
+ "/api/v2/sdk/transactions/summary": {
434
711
  "get": {
435
- "operationId": "transactions.getCompanyTransactions",
712
+ "description": "Returns aggregated transaction statistics: total invested, total realized, transaction count, company count, and breakdown by transaction type. Optionally group by period (Month, Quarter, Year). Filter by company, company group, and date range.",
713
+ "operationId": "transactions.getSummary",
436
714
  "parameters": [
437
- {
438
- "name": "id",
439
- "required": true,
440
- "in": "path",
441
- "description": "Company identifier",
442
- "schema": {
443
- "type": "number"
444
- }
445
- },
446
715
  {
447
716
  "name": "limit",
448
717
  "required": false,
@@ -465,7 +734,7 @@
465
734
  "name": "companyGroupIds",
466
735
  "required": false,
467
736
  "in": "query",
468
- "description": "Optional company group identifiers to filter transactions by",
737
+ "description": "Restrict to companies that belong to any of these company groups.",
469
738
  "schema": {
470
739
  "type": "array",
471
740
  "items": {
@@ -474,18 +743,150 @@
474
743
  }
475
744
  },
476
745
  {
477
- "name": "types",
746
+ "name": "companyIds",
478
747
  "required": false,
479
748
  "in": "query",
480
- "description": "Restrict results to these transaction types",
749
+ "description": "Restrict to these company identifiers.",
481
750
  "schema": {
482
751
  "type": "array",
483
752
  "items": {
484
- "type": "string",
485
- "enum": [
486
- "Auction",
487
- "ConvertibleNote",
488
- "ConvertToEquity",
753
+ "type": "number"
754
+ }
755
+ }
756
+ },
757
+ {
758
+ "name": "currency",
759
+ "required": true,
760
+ "in": "query",
761
+ "description": "Reporting currency code (ISO 4217).",
762
+ "schema": {
763
+ "type": "string"
764
+ }
765
+ },
766
+ {
767
+ "name": "groupBy",
768
+ "required": false,
769
+ "in": "query",
770
+ "description": "Group results by this period granularity. When omitted, returns a single summary across all time.",
771
+ "schema": {
772
+ "type": "string",
773
+ "enum": [
774
+ "Month",
775
+ "Quarter",
776
+ "Year"
777
+ ]
778
+ }
779
+ },
780
+ {
781
+ "name": "from",
782
+ "required": false,
783
+ "in": "query",
784
+ "description": "Lower bound for transaction date (ISO 8601, inclusive).",
785
+ "schema": {
786
+ "type": "string"
787
+ }
788
+ },
789
+ {
790
+ "name": "to",
791
+ "required": false,
792
+ "in": "query",
793
+ "description": "Upper bound for transaction date (ISO 8601, inclusive).",
794
+ "schema": {
795
+ "type": "string"
796
+ }
797
+ }
798
+ ],
799
+ "responses": {
800
+ "200": {
801
+ "description": "",
802
+ "content": {
803
+ "application/json": {
804
+ "schema": {
805
+ "$ref": "#/components/schemas/SdkTransactionSummaryResponseDto"
806
+ }
807
+ }
808
+ }
809
+ },
810
+ "401": {
811
+ "description": "Missing or invalid SDK credentials"
812
+ }
813
+ },
814
+ "security": [
815
+ {
816
+ "sdk-embed-token": []
817
+ },
818
+ {
819
+ "sdk-client-api-key": []
820
+ }
821
+ ],
822
+ "summary": "Get transaction activity summary",
823
+ "tags": [
824
+ "sdk-transactions"
825
+ ],
826
+ "x-sdk-audiences": [
827
+ "embed",
828
+ "client"
829
+ ],
830
+ "x-sdk-namespace": "transactions",
831
+ "x-sdk-operation": "getSummary"
832
+ }
833
+ },
834
+ "/api/v2/sdk/transactions/companies/{id}": {
835
+ "get": {
836
+ "operationId": "transactions.getCompanyTransactions",
837
+ "parameters": [
838
+ {
839
+ "name": "id",
840
+ "required": true,
841
+ "in": "path",
842
+ "description": "Company identifier",
843
+ "schema": {
844
+ "type": "number"
845
+ }
846
+ },
847
+ {
848
+ "name": "limit",
849
+ "required": false,
850
+ "in": "query",
851
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination.",
852
+ "schema": {
853
+ "type": "number"
854
+ }
855
+ },
856
+ {
857
+ "name": "cursor",
858
+ "required": false,
859
+ "in": "query",
860
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored.",
861
+ "schema": {
862
+ "type": "string"
863
+ }
864
+ },
865
+ {
866
+ "name": "companyGroupIds",
867
+ "required": false,
868
+ "in": "query",
869
+ "description": "Optional company group identifiers to filter transactions by",
870
+ "schema": {
871
+ "type": "array",
872
+ "items": {
873
+ "type": "number"
874
+ }
875
+ }
876
+ },
877
+ {
878
+ "name": "types",
879
+ "required": false,
880
+ "in": "query",
881
+ "description": "Restrict results to these transaction types",
882
+ "schema": {
883
+ "type": "array",
884
+ "items": {
885
+ "type": "string",
886
+ "enum": [
887
+ "Auction",
888
+ "ConvertibleNote",
889
+ "ConvertToEquity",
489
890
  "Dividend",
490
891
  "EquityInvestment",
491
892
  "EquityReceived",
@@ -679,7 +1080,7 @@
679
1080
  },
680
1081
  "/api/v2/sdk/metrics/types": {
681
1082
  "get": {
682
- "description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry includes a numeric id and a human-readable name suitable for display or LLM context.",
1083
+ "description": "Returns predefined metric types plus user-defined metric types scoped to the caller — VC group custom types for VC users, company custom types for company users. Each entry carries the metric shape needed to interpret values: `valueType` is `\"numeric\"` (read `point.value` as a number; may carry `rangeConfig` with min/max/step for ranged metrics) or `\"option\"` (read `point.optionValue` as a string from `optionConfig.options[]` — this is how boolean / yes-no metrics are encoded, as two options typically labelled \"Yes\"/\"No\"). `unit.unit` describes the measurement (`Currency`, `Percentage`, `Number`, time units, ...); `unit.currencyCode` is intentionally null on this endpoint because monetary types resolve their concrete currency per company — call /metrics to receive `unit.currencyCode` populated with each company's native currency, or pass `currency` to convert all monetary metrics to a chosen target.",
683
1084
  "operationId": "metrics.getTypes",
684
1085
  "parameters": [],
685
1086
  "responses": {
@@ -719,7 +1120,7 @@
719
1120
  },
720
1121
  "/api/v2/sdk/metrics": {
721
1122
  "post": {
722
- "description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Filter by company, company group, metric type, timeframe, and date range to narrow the response.",
1123
+ "description": "Returns metric data points for companies the caller can access (companies in the caller's VC group portfolio, or the caller's own company for company users). Each entry carries company and metric type references with id and human-readable name. Each point carries both `value` (number, for `valueType === \"numeric\"`, including ranged numerics constrained by the type's `rangeConfig`) and `optionValue` (string, for `valueType === \"option\"`, matching one of `metricType.optionConfig.options[].value` — this is how boolean/yes-no metrics report their reading); read whichever matches the metric type's `valueType`. Filter by company id, company name substring (`companyNameSearch`), company group, metric type id, metric type name (`metricTypeNames`), timeframe, and date range to narrow the response. Pass `currency` (ISO 4217) to FX-convert monetary metrics to that target currency in one call instead of fetching company currencies separately.",
723
1124
  "operationId": "metrics.search",
724
1125
  "parameters": [],
725
1126
  "requestBody": {
@@ -767,9 +1168,109 @@
767
1168
  "x-sdk-operation": "search"
768
1169
  }
769
1170
  },
1171
+ "/api/v2/sdk/metrics/compare": {
1172
+ "post": {
1173
+ "description": "Returns date-aligned rows for one or more metric types across multiple companies. Pass `metricTypeIds` (resolve from /metrics/types) to compare several metrics in a single round trip; names are not accepted on this endpoint to keep selection stable. Each row contains one value per company for a given period. Optionally includes period-over-period percentage change. Use `companyIds`, `companyNameSearch`, or `companyGroupIds` to select companies.",
1174
+ "operationId": "metrics.compare",
1175
+ "parameters": [],
1176
+ "requestBody": {
1177
+ "required": true,
1178
+ "content": {
1179
+ "application/json": {
1180
+ "schema": {
1181
+ "$ref": "#/components/schemas/MetricCompareDto"
1182
+ }
1183
+ }
1184
+ }
1185
+ },
1186
+ "responses": {
1187
+ "200": {
1188
+ "description": "",
1189
+ "content": {
1190
+ "application/json": {
1191
+ "schema": {
1192
+ "$ref": "#/components/schemas/SdkMetricCompareMultiResponseDto"
1193
+ }
1194
+ }
1195
+ }
1196
+ },
1197
+ "401": {
1198
+ "description": "Missing or invalid SDK credentials"
1199
+ }
1200
+ },
1201
+ "security": [
1202
+ {
1203
+ "sdk-embed-token": []
1204
+ },
1205
+ {
1206
+ "sdk-client-api-key": []
1207
+ }
1208
+ ],
1209
+ "summary": "Compare metrics across companies",
1210
+ "tags": [
1211
+ "sdk-metrics"
1212
+ ],
1213
+ "x-sdk-audiences": [
1214
+ "embed",
1215
+ "client"
1216
+ ],
1217
+ "x-sdk-namespace": "metrics",
1218
+ "x-sdk-operation": "compare"
1219
+ }
1220
+ },
1221
+ "/api/v2/sdk/metrics/aggregate": {
1222
+ "post": {
1223
+ "description": "Returns aggregated metric values (SUM, AVG, MEDIAN, MIN, MAX, COUNT) across companies for each reporting period. Pass `metricTypeIds` (resolve from /metrics/types) to select what to aggregate; names are not accepted on this endpoint to keep selection stable. Optionally group results by company group for fund-level breakdowns. MIN, MAX, and COUNT are always computed. SUM, AVG, and MEDIAN are only produced when the metric type enables them in its `summaryAggregationMethods` configuration; otherwise `point.value` is `null` for that aggregation.",
1224
+ "operationId": "metrics.aggregate",
1225
+ "parameters": [],
1226
+ "requestBody": {
1227
+ "required": true,
1228
+ "content": {
1229
+ "application/json": {
1230
+ "schema": {
1231
+ "$ref": "#/components/schemas/MetricAggregateDto"
1232
+ }
1233
+ }
1234
+ }
1235
+ },
1236
+ "responses": {
1237
+ "200": {
1238
+ "description": "",
1239
+ "content": {
1240
+ "application/json": {
1241
+ "schema": {
1242
+ "$ref": "#/components/schemas/SdkMetricAggregateResponseDto"
1243
+ }
1244
+ }
1245
+ }
1246
+ },
1247
+ "401": {
1248
+ "description": "Missing or invalid SDK credentials"
1249
+ }
1250
+ },
1251
+ "security": [
1252
+ {
1253
+ "sdk-embed-token": []
1254
+ },
1255
+ {
1256
+ "sdk-client-api-key": []
1257
+ }
1258
+ ],
1259
+ "summary": "Aggregate metrics across portfolio companies",
1260
+ "tags": [
1261
+ "sdk-metrics"
1262
+ ],
1263
+ "x-sdk-audiences": [
1264
+ "embed",
1265
+ "client"
1266
+ ],
1267
+ "x-sdk-namespace": "metrics",
1268
+ "x-sdk-operation": "aggregate"
1269
+ }
1270
+ },
770
1271
  "/api/v2/sdk/company-reports": {
771
1272
  "get": {
772
- "description": "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids and reporting period (timeframe + date range).",
1273
+ "description": "Returns lightweight report metadata (id, title, period, publisher company reference). Use GET /company-reports/:id to fetch the full content of a specific report. Visibility is determined by the caller's roles — VC users see reports for managed-portfolio companies, company employees see their own company's reports, portfolio investors see Published reports shared with their visibility groups. Filters narrow the list by company ids, company groups, company name substring (`companyNameSearch`), and reporting period (timeframe + date range).",
773
1274
  "operationId": "companyReports.list",
774
1275
  "parameters": [
775
1276
  {
@@ -814,6 +1315,18 @@
814
1315
  }
815
1316
  }
816
1317
  },
1318
+ {
1319
+ "name": "companyNameSearch",
1320
+ "required": false,
1321
+ "in": "query",
1322
+ "description": "Case-insensitive substring match on the reporting company name. Pass an array to resolve multiple companies in one call — a report matches if its company name contains ANY of the listed substrings (OR semantics). Intersects with `companyIds`/`companyGroupIds`.",
1323
+ "schema": {
1324
+ "type": "array",
1325
+ "items": {
1326
+ "type": "string"
1327
+ }
1328
+ }
1329
+ },
817
1330
  {
818
1331
  "name": "timeframe",
819
1332
  "required": false,
@@ -957,33 +1470,98 @@
957
1470
  }
958
1471
  },
959
1472
  "schemas": {
960
- "SdkCompanyDto": {
1473
+ "GetBatchDashboardBodyDto": {
961
1474
  "type": "object",
962
1475
  "properties": {
963
- "id": {
964
- "type": "number",
965
- "description": "Company identifier"
1476
+ "companyIds": {
1477
+ "description": "Company identifiers to include in the batch.",
1478
+ "type": "array",
1479
+ "items": {
1480
+ "type": "number"
1481
+ }
966
1482
  },
967
- "name": {
1483
+ "currency": {
968
1484
  "type": "string",
969
- "description": "Company display name"
1485
+ "description": "Reporting currency code (ISO 4217)."
970
1486
  },
971
- "type": {
1487
+ "metricsFrom": {
972
1488
  "type": "string",
973
- "description": "Company type",
974
- "nullable": true
1489
+ "description": "Lower bound for metric data points (ISO 8601). Omit to include all available history."
975
1490
  },
976
- "website": {
1491
+ "metricsTimeframe": {
977
1492
  "type": "string",
978
- "description": "Company website URL",
979
- "nullable": true
1493
+ "description": "Restrict metric data points to this reporting period granularity.",
1494
+ "enum": [
1495
+ "Month",
1496
+ "Quarter",
1497
+ "Year"
1498
+ ]
980
1499
  },
981
- "currency": {
982
- "type": "string",
983
- "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
1500
+ "metricTypeNames": {
1501
+ "description": "Metric type names to include. Omit to include all metrics. Use metric type ids via `metricTypeIds` when ids are known.",
1502
+ "type": "array",
1503
+ "items": {
1504
+ "type": "string"
1505
+ }
984
1506
  },
985
- "logoImageFileUuid": {
986
- "type": "string",
1507
+ "metricTypeIds": {
1508
+ "description": "Metric type identifiers to include. Intersected with `metricTypeNames` when both are provided.",
1509
+ "type": "array",
1510
+ "items": {
1511
+ "type": "number"
1512
+ }
1513
+ },
1514
+ "conversionStrategy": {
1515
+ "type": "string",
1516
+ "description": "FX rate selection when converting monetary metrics. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date.",
1517
+ "enum": [
1518
+ "LATEST_FX_RATE",
1519
+ "ENTITY_DATE_RATE"
1520
+ ]
1521
+ },
1522
+ "transactionLimit": {
1523
+ "type": "number",
1524
+ "description": "Maximum number of transactions per company (most recent first). Defaults to 10.",
1525
+ "default": 10
1526
+ },
1527
+ "reportLimit": {
1528
+ "type": "number",
1529
+ "description": "Maximum number of reports per company (most recent first). Defaults to 5.",
1530
+ "default": 5
1531
+ }
1532
+ },
1533
+ "required": [
1534
+ "companyIds",
1535
+ "currency"
1536
+ ]
1537
+ },
1538
+ "SdkCompanyDto": {
1539
+ "type": "object",
1540
+ "properties": {
1541
+ "id": {
1542
+ "type": "number",
1543
+ "description": "Company identifier"
1544
+ },
1545
+ "name": {
1546
+ "type": "string",
1547
+ "description": "Company display name"
1548
+ },
1549
+ "type": {
1550
+ "type": "string",
1551
+ "description": "Company type",
1552
+ "nullable": true
1553
+ },
1554
+ "website": {
1555
+ "type": "string",
1556
+ "description": "Company website URL",
1557
+ "nullable": true
1558
+ },
1559
+ "currency": {
1560
+ "type": "string",
1561
+ "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
1562
+ },
1563
+ "logoImageFileUuid": {
1564
+ "type": "string",
987
1565
  "description": "Logo image file UUID",
988
1566
  "nullable": true
989
1567
  },
@@ -1070,7 +1648,7 @@
1070
1648
  "logoImageFileUuid"
1071
1649
  ]
1072
1650
  },
1073
- "SdkCompactCompanyDto": {
1651
+ "SdkCompanyReferenceDto": {
1074
1652
  "type": "object",
1075
1653
  "properties": {
1076
1654
  "id": {
@@ -1085,141 +1663,1002 @@
1085
1663
  "type": "string",
1086
1664
  "description": "Company type",
1087
1665
  "nullable": true
1088
- },
1089
- "website": {
1090
- "type": "string",
1091
- "description": "Company website URL",
1092
- "nullable": true
1093
- },
1094
- "currency": {
1095
- "type": "string",
1096
- "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
1097
- },
1098
- "logoImageFileUuid": {
1099
- "type": "string",
1100
- "description": "Logo image file UUID",
1101
- "nullable": true
1102
1666
  }
1103
1667
  },
1104
1668
  "required": [
1105
1669
  "id",
1106
1670
  "name",
1107
- "type",
1108
- "currency",
1109
- "logoImageFileUuid"
1110
- ]
1111
- },
1112
- "SdkPaginationMetaDto": {
1113
- "type": "object",
1114
- "properties": {
1115
- "nextCursor": {
1116
- "type": "string",
1117
- "description": "Cursor for the next page; null when no more pages are available",
1118
- "nullable": true
1119
- }
1120
- },
1121
- "required": [
1122
- "nextCursor"
1671
+ "type"
1123
1672
  ]
1124
1673
  },
1125
- "SdkCompaniesListResponseDto": {
1674
+ "SdkCompanyGroupReferenceDto": {
1126
1675
  "type": "object",
1127
1676
  "properties": {
1128
- "data": {
1129
- "type": "array",
1130
- "items": {
1131
- "$ref": "#/components/schemas/SdkCompactCompanyDto"
1132
- }
1677
+ "id": {
1678
+ "type": "number",
1679
+ "description": "Company group identifier"
1133
1680
  },
1134
- "meta": {
1135
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
1681
+ "name": {
1682
+ "type": "string",
1683
+ "description": "Company group name"
1136
1684
  }
1137
1685
  },
1138
1686
  "required": [
1139
- "data",
1140
- "meta"
1687
+ "id",
1688
+ "name"
1141
1689
  ]
1142
1690
  },
1143
- "SdkCompactCompanyGroupDto": {
1691
+ "SdkFairValueItemDto": {
1144
1692
  "type": "object",
1145
1693
  "properties": {
1146
1694
  "id": {
1147
1695
  "type": "number",
1148
- "description": "Company group identifier"
1149
- },
1150
- "name": {
1151
- "type": "string",
1152
- "description": "Company group name"
1696
+ "description": "Fair value item identifier"
1153
1697
  },
1154
- "isDemo": {
1155
- "type": "boolean",
1156
- "description": "Whether this group holds demo data only"
1698
+ "companyGroupId": {
1699
+ "type": "number",
1700
+ "description": "Company group identifier"
1157
1701
  },
1158
- "colorId": {
1702
+ "fairValue": {
1159
1703
  "type": "number",
1160
- "description": "UI theme color identifier",
1161
- "nullable": true
1704
+ "description": "Fair value amount"
1162
1705
  },
1163
- "companyIds": {
1164
- "description": "Company identifiers associated with the group",
1165
- "type": "array",
1166
- "items": {
1167
- "type": "number"
1168
- }
1706
+ "type": {
1707
+ "type": "string",
1708
+ "description": "Transaction type",
1709
+ "enum": [
1710
+ "Auction",
1711
+ "ConvertibleNote",
1712
+ "ConvertToEquity",
1713
+ "Dividend",
1714
+ "EquityInvestment",
1715
+ "EquityReceived",
1716
+ "Extend",
1717
+ "FutureEquityAgreement",
1718
+ "Insolvency",
1719
+ "IPO",
1720
+ "LimitedAuction",
1721
+ "OptionsReceived",
1722
+ "OtherExit",
1723
+ "OtherInvestment",
1724
+ "OtherRealization",
1725
+ "Payback",
1726
+ "Proprietary",
1727
+ "TradeSale",
1728
+ "ValuationChange",
1729
+ "WriteOff"
1730
+ ]
1169
1731
  }
1170
1732
  },
1171
1733
  "required": [
1172
1734
  "id",
1173
- "name",
1174
- "isDemo"
1735
+ "companyGroupId",
1736
+ "fairValue",
1737
+ "type"
1175
1738
  ]
1176
1739
  },
1177
- "SdkCompanyGroupsListResponseDto": {
1740
+ "InvestorType": {
1741
+ "type": "string",
1742
+ "enum": [
1743
+ "organization",
1744
+ "individual"
1745
+ ],
1746
+ "description": "Investor type"
1747
+ },
1748
+ "SdkSignificantInvestorDto": {
1178
1749
  "type": "object",
1179
1750
  "properties": {
1180
- "data": {
1181
- "type": "array",
1182
- "items": {
1183
- "$ref": "#/components/schemas/SdkCompactCompanyGroupDto"
1184
- }
1751
+ "investorType": {
1752
+ "description": "Investor type",
1753
+ "allOf": [
1754
+ {
1755
+ "$ref": "#/components/schemas/InvestorType"
1756
+ }
1757
+ ]
1185
1758
  },
1186
- "meta": {
1187
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
1759
+ "name": {
1760
+ "type": "string",
1761
+ "description": "Investor name"
1762
+ },
1763
+ "lastName": {
1764
+ "type": "string",
1765
+ "description": "Investor last name"
1766
+ },
1767
+ "email": {
1768
+ "type": "string",
1769
+ "description": "Investor email"
1770
+ },
1771
+ "website": {
1772
+ "type": "string",
1773
+ "description": "Investor website"
1188
1774
  }
1189
1775
  },
1190
1776
  "required": [
1191
- "data",
1192
- "meta"
1777
+ "investorType",
1778
+ "name"
1193
1779
  ]
1194
1780
  },
1195
- "SdkCompanyGroupBasicInformationDto": {
1781
+ "SdkFundingRoundInfoDto": {
1196
1782
  "type": "object",
1197
1783
  "properties": {
1198
- "fullName": {
1784
+ "roundType": {
1199
1785
  "type": "string",
1200
- "description": "Full legal name of the fund or group",
1786
+ "description": "Funding round type",
1787
+ "enum": [
1788
+ "poc",
1789
+ "pre-seed",
1790
+ "seed",
1791
+ "late-seed",
1792
+ "seed-extension",
1793
+ "pre-series-a-round",
1794
+ "bridge-round",
1795
+ "a-round",
1796
+ "b-round",
1797
+ "c-round",
1798
+ "d-round-plus",
1799
+ "d-round",
1800
+ "e-round",
1801
+ "f-round",
1802
+ "g-round",
1803
+ "h-round",
1804
+ "i-round",
1805
+ "j-round",
1806
+ "k-round",
1807
+ "l-round",
1808
+ "m-round",
1809
+ "n-round"
1810
+ ],
1201
1811
  "nullable": true
1202
1812
  },
1203
- "domicile": {
1813
+ "roleInRound": {
1204
1814
  "type": "string",
1205
- "description": "Country or jurisdiction of domicile",
1815
+ "description": "Role in the round",
1816
+ "enum": [
1817
+ "lead",
1818
+ "co-lead",
1819
+ "minority-co-investor",
1820
+ "did-not-participate"
1821
+ ],
1206
1822
  "nullable": true
1207
1823
  },
1208
- "managementCompany": {
1209
- "type": "string",
1210
- "description": "Name of the management company",
1211
- "nullable": true
1824
+ "significantInvestors": {
1825
+ "description": "Significant investors in the round",
1826
+ "type": "array",
1827
+ "items": {
1828
+ "$ref": "#/components/schemas/SdkSignificantInvestorDto"
1829
+ }
1212
1830
  },
1213
- "generalPartner": {
1214
- "type": "string",
1215
- "description": "Name of the general partner",
1831
+ "roundSize": {
1832
+ "type": "number",
1833
+ "description": "Round size",
1216
1834
  "nullable": true
1217
1835
  },
1218
- "vintageYear": {
1836
+ "totalFundingRaised": {
1219
1837
  "type": "number",
1220
- "description": "Vintage year",
1838
+ "description": "Total funding raised at the round time",
1221
1839
  "nullable": true
1222
- },
1840
+ }
1841
+ }
1842
+ },
1843
+ "SdkCompanyPositionDto": {
1844
+ "type": "object",
1845
+ "properties": {
1846
+ "companyId": {
1847
+ "type": "number",
1848
+ "description": "Company identifier"
1849
+ },
1850
+ "companyGroupId": {
1851
+ "type": "number",
1852
+ "description": "Company group identifier",
1853
+ "nullable": true
1854
+ },
1855
+ "company": {
1856
+ "description": "Company reference",
1857
+ "allOf": [
1858
+ {
1859
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
1860
+ }
1861
+ ]
1862
+ },
1863
+ "companyGroup": {
1864
+ "description": "Company group reference",
1865
+ "allOf": [
1866
+ {
1867
+ "$ref": "#/components/schemas/SdkCompanyGroupReferenceDto"
1868
+ }
1869
+ ]
1870
+ },
1871
+ "investmentStatus": {
1872
+ "type": "string",
1873
+ "description": "Investment status",
1874
+ "nullable": true
1875
+ },
1876
+ "invested": {
1877
+ "type": "number",
1878
+ "description": "Total invested amount"
1879
+ },
1880
+ "ownership": {
1881
+ "type": "number",
1882
+ "description": "Ownership percentage",
1883
+ "nullable": true
1884
+ },
1885
+ "companyValuation": {
1886
+ "type": "number",
1887
+ "description": "Company valuation",
1888
+ "nullable": true
1889
+ },
1890
+ "sharesOwnedTotal": {
1891
+ "type": "number",
1892
+ "description": "Number of units held"
1893
+ },
1894
+ "pricePerShare": {
1895
+ "type": "number",
1896
+ "description": "Price per share",
1897
+ "nullable": true
1898
+ },
1899
+ "sharesIssuedTotalDiluted": {
1900
+ "type": "number",
1901
+ "description": "Total diluted shares issued"
1902
+ },
1903
+ "sharesIssuedTotalCurrent": {
1904
+ "type": "number",
1905
+ "description": "Total current shares issued"
1906
+ },
1907
+ "fairValueWithoutEquity": {
1908
+ "type": "number",
1909
+ "description": "Fair value excluding equity",
1910
+ "nullable": true
1911
+ },
1912
+ "fairValue": {
1913
+ "type": "number",
1914
+ "description": "Position fair value",
1915
+ "nullable": true
1916
+ },
1917
+ "customSummaryFairValue": {
1918
+ "type": "number",
1919
+ "description": "Custom fair value override applied at summary level",
1920
+ "nullable": true
1921
+ },
1922
+ "askFairValue": {
1923
+ "type": "boolean",
1924
+ "description": "Whether a fair value input is required",
1925
+ "nullable": true
1926
+ },
1927
+ "xirr": {
1928
+ "type": "number",
1929
+ "description": "Extended internal rate of return",
1930
+ "nullable": true
1931
+ },
1932
+ "roi": {
1933
+ "type": "number",
1934
+ "description": "Return on investment",
1935
+ "nullable": true
1936
+ },
1937
+ "realized": {
1938
+ "type": "number",
1939
+ "description": "Realized amount",
1940
+ "nullable": true
1941
+ },
1942
+ "investments": {
1943
+ "type": "number",
1944
+ "description": "Number of investments contributing to the position",
1945
+ "nullable": true
1946
+ },
1947
+ "defaultFairValueItems": {
1948
+ "description": "Default fair value items",
1949
+ "type": "array",
1950
+ "items": {
1951
+ "$ref": "#/components/schemas/SdkFairValueItemDto"
1952
+ }
1953
+ },
1954
+ "totalProfits": {
1955
+ "type": "number",
1956
+ "description": "Total profits",
1957
+ "nullable": true
1958
+ },
1959
+ "exitProfits": {
1960
+ "type": "number",
1961
+ "description": "Exit profits",
1962
+ "nullable": true
1963
+ },
1964
+ "equityFairValue": {
1965
+ "type": "number",
1966
+ "description": "Equity fair value",
1967
+ "nullable": true
1968
+ },
1969
+ "multiple": {
1970
+ "type": "number",
1971
+ "description": "Investment multiple",
1972
+ "nullable": true
1973
+ },
1974
+ "roundInfo": {
1975
+ "description": "Funding round info",
1976
+ "nullable": true,
1977
+ "type": "object",
1978
+ "allOf": [
1979
+ {
1980
+ "$ref": "#/components/schemas/SdkFundingRoundInfoDto"
1981
+ }
1982
+ ]
1983
+ },
1984
+ "valuationMethod": {
1985
+ "type": "string",
1986
+ "description": "Valuation method",
1987
+ "enum": [
1988
+ "Historical",
1989
+ "NewFinancingRound",
1990
+ "PubliclyListedSecurity",
1991
+ "Realization",
1992
+ "RecentTransactionMultiples",
1993
+ "RecentMarketMultiples",
1994
+ "RecentMarketAndTransactionMultiples",
1995
+ "DiscountToPrimaryRound",
1996
+ "ThirdPartyOpinion",
1997
+ "Dcf",
1998
+ "Other"
1999
+ ],
2000
+ "nullable": true
2001
+ },
2002
+ "totalFundingRaised": {
2003
+ "type": "number",
2004
+ "description": "Total funding raised",
2005
+ "nullable": true
2006
+ },
2007
+ "averageInvestmentAmount": {
2008
+ "type": "number",
2009
+ "description": "Average investment amount",
2010
+ "nullable": true
2011
+ },
2012
+ "investedInitial": {
2013
+ "type": "number",
2014
+ "description": "Initially invested amount",
2015
+ "nullable": true
2016
+ },
2017
+ "investedFollowOn": {
2018
+ "type": "number",
2019
+ "description": "Follow-on invested amount",
2020
+ "nullable": true
2021
+ },
2022
+ "dateOfInitialInvestment": {
2023
+ "type": "string",
2024
+ "description": "Initial investment date",
2025
+ "nullable": true
2026
+ },
2027
+ "initialInvestmentStage": {
2028
+ "type": "string",
2029
+ "description": "Initial investment stage",
2030
+ "enum": [
2031
+ "poc",
2032
+ "pre-seed",
2033
+ "seed",
2034
+ "late-seed",
2035
+ "seed-extension",
2036
+ "pre-series-a-round",
2037
+ "bridge-round",
2038
+ "a-round",
2039
+ "b-round",
2040
+ "c-round",
2041
+ "d-round-plus",
2042
+ "d-round",
2043
+ "e-round",
2044
+ "f-round",
2045
+ "g-round",
2046
+ "h-round",
2047
+ "i-round",
2048
+ "j-round",
2049
+ "k-round",
2050
+ "l-round",
2051
+ "m-round",
2052
+ "n-round"
2053
+ ],
2054
+ "nullable": true
2055
+ },
2056
+ "latestInvestment": {
2057
+ "type": "number",
2058
+ "description": "Latest investment amount",
2059
+ "nullable": true
2060
+ },
2061
+ "dateOfLatestInvestment": {
2062
+ "type": "string",
2063
+ "description": "Latest investment date",
2064
+ "nullable": true
2065
+ },
2066
+ "currentStage": {
2067
+ "type": "string",
2068
+ "description": "Current stage",
2069
+ "enum": [
2070
+ "poc",
2071
+ "pre-seed",
2072
+ "seed",
2073
+ "late-seed",
2074
+ "seed-extension",
2075
+ "pre-series-a-round",
2076
+ "bridge-round",
2077
+ "a-round",
2078
+ "b-round",
2079
+ "c-round",
2080
+ "d-round-plus",
2081
+ "d-round",
2082
+ "e-round",
2083
+ "f-round",
2084
+ "g-round",
2085
+ "h-round",
2086
+ "i-round",
2087
+ "j-round",
2088
+ "k-round",
2089
+ "l-round",
2090
+ "m-round",
2091
+ "n-round"
2092
+ ],
2093
+ "nullable": true
2094
+ },
2095
+ "currency": {
2096
+ "type": "string",
2097
+ "description": "Reporting currency code"
2098
+ },
2099
+ "date": {
2100
+ "type": "string",
2101
+ "description": "Position summary date"
2102
+ }
2103
+ },
2104
+ "required": [
2105
+ "companyId",
2106
+ "invested",
2107
+ "sharesOwnedTotal",
2108
+ "sharesIssuedTotalDiluted",
2109
+ "sharesIssuedTotalCurrent",
2110
+ "currency",
2111
+ "date"
2112
+ ]
2113
+ },
2114
+ "SdkMetricUnitDto": {
2115
+ "type": "object",
2116
+ "properties": {
2117
+ "unit": {
2118
+ "type": "object",
2119
+ "description": "Unit category. Examples: \"Currency\", \"Percentage\", \"Number\", \"Day\", \"Month\", \"Quarter\", \"Year\"."
2120
+ },
2121
+ "currencyCode": {
2122
+ "type": "string",
2123
+ "description": "ISO 4217 currency code, only populated when the unit is \"Currency\" *and* a per-company context is known. On /metrics this reflects the company's native currency (or the requested `currency` target when FX-converted). On /metrics/types it is always null — the type is shared across companies, so no single code applies; resolve it via /metrics.",
2124
+ "nullable": true
2125
+ }
2126
+ },
2127
+ "required": [
2128
+ "unit"
2129
+ ]
2130
+ },
2131
+ "SdkMetricTypeOptionDto": {
2132
+ "type": "object",
2133
+ "properties": {
2134
+ "value": {
2135
+ "type": "string",
2136
+ "description": "Allowed option value as it appears in `points[].optionValue`. For boolean (yes/no) metrics the options are typically \"Yes\" and \"No\"."
2137
+ },
2138
+ "isPositive": {
2139
+ "type": "boolean",
2140
+ "description": "Whether this option counts as a positive outcome (e.g. \"Yes\" is usually positive)."
2141
+ }
2142
+ },
2143
+ "required": [
2144
+ "value",
2145
+ "isPositive"
2146
+ ]
2147
+ },
2148
+ "SdkMetricTypeOptionConfigDto": {
2149
+ "type": "object",
2150
+ "properties": {
2151
+ "options": {
2152
+ "description": "Allowed values for option-valued metrics. Each point's `optionValue` must match one of these. Boolean metrics surface here as two options (commonly \"Yes\"/\"No\").",
2153
+ "type": "array",
2154
+ "items": {
2155
+ "$ref": "#/components/schemas/SdkMetricTypeOptionDto"
2156
+ }
2157
+ }
2158
+ },
2159
+ "required": [
2160
+ "options"
2161
+ ]
2162
+ },
2163
+ "SdkMetricTypeRangeConfigDto": {
2164
+ "type": "object",
2165
+ "properties": {
2166
+ "min": {
2167
+ "type": "number",
2168
+ "description": "Inclusive lower bound for valid numeric values."
2169
+ },
2170
+ "max": {
2171
+ "type": "number",
2172
+ "description": "Inclusive upper bound for valid numeric values."
2173
+ },
2174
+ "step": {
2175
+ "type": "number",
2176
+ "description": "Step / increment between valid values."
2177
+ }
2178
+ },
2179
+ "required": [
2180
+ "min",
2181
+ "max",
2182
+ "step"
2183
+ ]
2184
+ },
2185
+ "SdkMetricTypeDto": {
2186
+ "type": "object",
2187
+ "properties": {
2188
+ "id": {
2189
+ "type": "number",
2190
+ "description": "Metric type identifier."
2191
+ },
2192
+ "name": {
2193
+ "type": "string",
2194
+ "description": "Metric type display name."
2195
+ },
2196
+ "shortName": {
2197
+ "type": "string",
2198
+ "description": "Short display name / abbreviation.",
2199
+ "nullable": true
2200
+ },
2201
+ "description": {
2202
+ "type": "string",
2203
+ "description": "Free-form description of what the metric represents.",
2204
+ "nullable": true
2205
+ },
2206
+ "origin": {
2207
+ "type": "object",
2208
+ "description": "Origin: predefined by Rundit or user-defined within the VC group."
2209
+ },
2210
+ "aggMethod": {
2211
+ "type": "object",
2212
+ "description": "How values aggregate across periods when rolled up (e.g. SUM, AVG, LAST_AVAILABLE, NONE)."
2213
+ },
2214
+ "valueType": {
2215
+ "type": "object",
2216
+ "description": "Shape of each point's value: `\"numeric\"` — read `points[].value` as a number; `\"option\"` — read `points[].optionValue` as a string from `optionConfig.options[]` (this is how boolean / yes-no metrics are encoded — two options, typically \"Yes\"/\"No\"). Numeric metrics may additionally carry a `rangeConfig` constraining `value` to [min, max] with a `step`."
2217
+ },
2218
+ "unit": {
2219
+ "description": "Unit of measurement.",
2220
+ "nullable": true,
2221
+ "type": "object",
2222
+ "allOf": [
2223
+ {
2224
+ "$ref": "#/components/schemas/SdkMetricUnitDto"
2225
+ }
2226
+ ]
2227
+ },
2228
+ "optionConfig": {
2229
+ "description": "Allowed values when `valueType === \"option\"`. Each point reports its choice in `optionValue`. Boolean (yes/no) metrics surface here as two options.",
2230
+ "nullable": true,
2231
+ "type": "object",
2232
+ "allOf": [
2233
+ {
2234
+ "$ref": "#/components/schemas/SdkMetricTypeOptionConfigDto"
2235
+ }
2236
+ ]
2237
+ },
2238
+ "rangeConfig": {
2239
+ "description": "Bounds for ranged numeric metrics: each point's `value` is constrained to `[min, max]` with the given `step`. Absent when the metric is unbounded.",
2240
+ "nullable": true,
2241
+ "type": "object",
2242
+ "allOf": [
2243
+ {
2244
+ "$ref": "#/components/schemas/SdkMetricTypeRangeConfigDto"
2245
+ }
2246
+ ]
2247
+ }
2248
+ },
2249
+ "required": [
2250
+ "id",
2251
+ "name",
2252
+ "aggMethod"
2253
+ ]
2254
+ },
2255
+ "SdkMetricPointDto": {
2256
+ "type": "object",
2257
+ "properties": {
2258
+ "date": {
2259
+ "type": "string",
2260
+ "description": "Period end date (ISO 8601, YYYY-MM-DD)."
2261
+ },
2262
+ "timeframe": {
2263
+ "type": "object",
2264
+ "description": "Reporting period granularity."
2265
+ },
2266
+ "value": {
2267
+ "type": "number",
2268
+ "description": "Numeric value for the period. Populated when the parent metric type has `valueType === \"numeric\"` (including ranged numerics). Null for option-valued metrics — read `optionValue` instead — or when the numeric value could not be computed.",
2269
+ "nullable": true
2270
+ },
2271
+ "optionValue": {
2272
+ "type": "string",
2273
+ "description": "String value for option-valued metrics (`valueType === \"option\"`). Matches one of the entries in the metric type's `optionConfig.options[].value` — e.g. \"Yes\"/\"No\" for boolean metrics. Null for numeric metrics or when no choice has been reported for the period.",
2274
+ "nullable": true
2275
+ },
2276
+ "valueError": {
2277
+ "type": "string",
2278
+ "description": "Computation error message, if the value could not be calculated.",
2279
+ "nullable": true
2280
+ },
2281
+ "aggregated": {
2282
+ "type": "boolean",
2283
+ "description": "True when the point is derived (e.g. aggregated from sub-rows) rather than directly stored."
2284
+ }
2285
+ },
2286
+ "required": [
2287
+ "date",
2288
+ "timeframe",
2289
+ "value",
2290
+ "optionValue"
2291
+ ]
2292
+ },
2293
+ "SdkCompanyMetricDto": {
2294
+ "type": "object",
2295
+ "properties": {
2296
+ "id": {
2297
+ "type": "number",
2298
+ "description": "Metric instance identifier (unique per company)."
2299
+ },
2300
+ "metricType": {
2301
+ "description": "Metric type definition.",
2302
+ "allOf": [
2303
+ {
2304
+ "$ref": "#/components/schemas/SdkMetricTypeDto"
2305
+ }
2306
+ ]
2307
+ },
2308
+ "points": {
2309
+ "description": "Reported data points for this metric.",
2310
+ "type": "array",
2311
+ "items": {
2312
+ "$ref": "#/components/schemas/SdkMetricPointDto"
2313
+ }
2314
+ }
2315
+ },
2316
+ "required": [
2317
+ "id",
2318
+ "metricType",
2319
+ "points"
2320
+ ]
2321
+ },
2322
+ "SdkCompanyDashboardMetricsDto": {
2323
+ "type": "object",
2324
+ "properties": {
2325
+ "companyId": {
2326
+ "type": "number",
2327
+ "description": "Company identifier."
2328
+ },
2329
+ "company": {
2330
+ "description": "Company reference.",
2331
+ "allOf": [
2332
+ {
2333
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
2334
+ }
2335
+ ]
2336
+ },
2337
+ "metrics": {
2338
+ "description": "All metrics with data points.",
2339
+ "type": "array",
2340
+ "items": {
2341
+ "$ref": "#/components/schemas/SdkCompanyMetricDto"
2342
+ }
2343
+ }
2344
+ },
2345
+ "required": [
2346
+ "companyId",
2347
+ "company",
2348
+ "metrics"
2349
+ ]
2350
+ },
2351
+ "SdkCompanyReportSummaryDto": {
2352
+ "type": "object",
2353
+ "properties": {
2354
+ "id": {
2355
+ "type": "number",
2356
+ "description": "Report identifier."
2357
+ },
2358
+ "title": {
2359
+ "type": "string",
2360
+ "description": "Human-readable report title."
2361
+ },
2362
+ "date": {
2363
+ "type": "string",
2364
+ "description": "Reporting period end date (ISO 8601, YYYY-MM-DD)."
2365
+ },
2366
+ "timeframe": {
2367
+ "type": "object",
2368
+ "description": "Reporting period granularity."
2369
+ },
2370
+ "publishedAt": {
2371
+ "type": "string",
2372
+ "description": "When the report was published (ISO 8601).",
2373
+ "nullable": true
2374
+ },
2375
+ "company": {
2376
+ "description": "Company that published the report.",
2377
+ "allOf": [
2378
+ {
2379
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
2380
+ }
2381
+ ]
2382
+ }
2383
+ },
2384
+ "required": [
2385
+ "id",
2386
+ "title",
2387
+ "date",
2388
+ "timeframe",
2389
+ "company"
2390
+ ]
2391
+ },
2392
+ "SdkCompanyDashboardDto": {
2393
+ "type": "object",
2394
+ "properties": {
2395
+ "company": {
2396
+ "description": "Full company metadata.",
2397
+ "allOf": [
2398
+ {
2399
+ "$ref": "#/components/schemas/SdkCompanyDto"
2400
+ }
2401
+ ]
2402
+ },
2403
+ "positions": {
2404
+ "description": "Positions per fund / company group.",
2405
+ "type": "array",
2406
+ "items": {
2407
+ "$ref": "#/components/schemas/SdkCompanyPositionDto"
2408
+ }
2409
+ },
2410
+ "metrics": {
2411
+ "description": "Metrics with data points. Each entry carries the metric type definition and reported data points.",
2412
+ "allOf": [
2413
+ {
2414
+ "$ref": "#/components/schemas/SdkCompanyDashboardMetricsDto"
2415
+ }
2416
+ ]
2417
+ },
2418
+ "transactions": {
2419
+ "type": "array",
2420
+ "description": "Recent transactions, ordered by date descending. Limited by `transactionLimit` query parameter.",
2421
+ "items": {
2422
+ "oneOf": [
2423
+ {
2424
+ "$ref": "#/components/schemas/SdkEquityTransactionDto"
2425
+ },
2426
+ {
2427
+ "$ref": "#/components/schemas/SdkConvertibleNoteTransactionDto"
2428
+ },
2429
+ {
2430
+ "$ref": "#/components/schemas/SdkFutureEquityAgreementTransactionDto"
2431
+ },
2432
+ {
2433
+ "$ref": "#/components/schemas/SdkExtendTransactionDto"
2434
+ },
2435
+ {
2436
+ "$ref": "#/components/schemas/SdkConversionTransactionDto"
2437
+ },
2438
+ {
2439
+ "$ref": "#/components/schemas/SdkExitTransactionDto"
2440
+ },
2441
+ {
2442
+ "$ref": "#/components/schemas/SdkValuationChangeTransactionDto"
2443
+ },
2444
+ {
2445
+ "$ref": "#/components/schemas/SdkInsolvencyTransactionDto"
2446
+ },
2447
+ {
2448
+ "$ref": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2449
+ }
2450
+ ],
2451
+ "discriminator": {
2452
+ "propertyName": "type",
2453
+ "mapping": {
2454
+ "EquityInvestment": "#/components/schemas/SdkEquityTransactionDto",
2455
+ "EquityReceived": "#/components/schemas/SdkEquityTransactionDto",
2456
+ "OptionsReceived": "#/components/schemas/SdkEquityTransactionDto",
2457
+ "ConvertibleNote": "#/components/schemas/SdkConvertibleNoteTransactionDto",
2458
+ "FutureEquityAgreement": "#/components/schemas/SdkFutureEquityAgreementTransactionDto",
2459
+ "Extend": "#/components/schemas/SdkExtendTransactionDto",
2460
+ "ConvertToEquity": "#/components/schemas/SdkConversionTransactionDto",
2461
+ "Payback": "#/components/schemas/SdkConversionTransactionDto",
2462
+ "WriteOff": "#/components/schemas/SdkConversionTransactionDto",
2463
+ "TradeSale": "#/components/schemas/SdkExitTransactionDto",
2464
+ "IPO": "#/components/schemas/SdkExitTransactionDto",
2465
+ "Auction": "#/components/schemas/SdkExitTransactionDto",
2466
+ "LimitedAuction": "#/components/schemas/SdkExitTransactionDto",
2467
+ "Proprietary": "#/components/schemas/SdkExitTransactionDto",
2468
+ "OtherExit": "#/components/schemas/SdkExitTransactionDto",
2469
+ "Dividend": "#/components/schemas/SdkExitTransactionDto",
2470
+ "OtherRealization": "#/components/schemas/SdkExitTransactionDto",
2471
+ "ValuationChange": "#/components/schemas/SdkValuationChangeTransactionDto",
2472
+ "Insolvency": "#/components/schemas/SdkInsolvencyTransactionDto",
2473
+ "OtherInvestment": "#/components/schemas/SdkOtherInvestmentTransactionDto"
2474
+ }
2475
+ }
2476
+ }
2477
+ },
2478
+ "reports": {
2479
+ "description": "Recent report summaries (metadata only). Limited by `reportLimit` query parameter.",
2480
+ "type": "array",
2481
+ "items": {
2482
+ "$ref": "#/components/schemas/SdkCompanyReportSummaryDto"
2483
+ }
2484
+ }
2485
+ },
2486
+ "required": [
2487
+ "company",
2488
+ "positions",
2489
+ "metrics",
2490
+ "transactions",
2491
+ "reports"
2492
+ ]
2493
+ },
2494
+ "SdkPaginationMetaDto": {
2495
+ "type": "object",
2496
+ "properties": {
2497
+ "nextCursor": {
2498
+ "type": "string",
2499
+ "description": "Cursor for the next page; null when no more pages are available",
2500
+ "nullable": true
2501
+ }
2502
+ },
2503
+ "required": [
2504
+ "nextCursor"
2505
+ ]
2506
+ },
2507
+ "SdkBatchDashboardResponseDto": {
2508
+ "type": "object",
2509
+ "properties": {
2510
+ "data": {
2511
+ "type": "array",
2512
+ "items": {
2513
+ "$ref": "#/components/schemas/SdkCompanyDashboardDto"
2514
+ }
2515
+ },
2516
+ "meta": {
2517
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
2518
+ }
2519
+ },
2520
+ "required": [
2521
+ "data",
2522
+ "meta"
2523
+ ]
2524
+ },
2525
+ "SdkCompactCompanyDto": {
2526
+ "type": "object",
2527
+ "properties": {
2528
+ "id": {
2529
+ "type": "number",
2530
+ "description": "Company identifier"
2531
+ },
2532
+ "name": {
2533
+ "type": "string",
2534
+ "description": "Company display name"
2535
+ },
2536
+ "type": {
2537
+ "type": "string",
2538
+ "description": "Company type",
2539
+ "nullable": true
2540
+ },
2541
+ "website": {
2542
+ "type": "string",
2543
+ "description": "Company website URL",
2544
+ "nullable": true
2545
+ },
2546
+ "currency": {
2547
+ "type": "string",
2548
+ "description": "Company reporting currency as ISO 4217 code (e.g. USD, EUR)"
2549
+ },
2550
+ "logoImageFileUuid": {
2551
+ "type": "string",
2552
+ "description": "Logo image file UUID",
2553
+ "nullable": true
2554
+ }
2555
+ },
2556
+ "required": [
2557
+ "id",
2558
+ "name",
2559
+ "type",
2560
+ "currency",
2561
+ "logoImageFileUuid"
2562
+ ]
2563
+ },
2564
+ "SdkCompaniesListResponseDto": {
2565
+ "type": "object",
2566
+ "properties": {
2567
+ "data": {
2568
+ "type": "array",
2569
+ "items": {
2570
+ "$ref": "#/components/schemas/SdkCompactCompanyDto"
2571
+ }
2572
+ },
2573
+ "meta": {
2574
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
2575
+ }
2576
+ },
2577
+ "required": [
2578
+ "data",
2579
+ "meta"
2580
+ ]
2581
+ },
2582
+ "SdkCompactCompanyGroupDto": {
2583
+ "type": "object",
2584
+ "properties": {
2585
+ "id": {
2586
+ "type": "number",
2587
+ "description": "Company group identifier"
2588
+ },
2589
+ "name": {
2590
+ "type": "string",
2591
+ "description": "Company group name"
2592
+ },
2593
+ "isDemo": {
2594
+ "type": "boolean",
2595
+ "description": "Whether this group holds demo data only"
2596
+ },
2597
+ "colorId": {
2598
+ "type": "number",
2599
+ "description": "UI theme color identifier",
2600
+ "nullable": true
2601
+ },
2602
+ "companyIds": {
2603
+ "description": "Company identifiers associated with the group",
2604
+ "type": "array",
2605
+ "items": {
2606
+ "type": "number"
2607
+ }
2608
+ }
2609
+ },
2610
+ "required": [
2611
+ "id",
2612
+ "name",
2613
+ "isDemo"
2614
+ ]
2615
+ },
2616
+ "SdkCompanyGroupsListResponseDto": {
2617
+ "type": "object",
2618
+ "properties": {
2619
+ "data": {
2620
+ "type": "array",
2621
+ "items": {
2622
+ "$ref": "#/components/schemas/SdkCompactCompanyGroupDto"
2623
+ }
2624
+ },
2625
+ "meta": {
2626
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
2627
+ }
2628
+ },
2629
+ "required": [
2630
+ "data",
2631
+ "meta"
2632
+ ]
2633
+ },
2634
+ "SdkCompanyGroupBasicInformationDto": {
2635
+ "type": "object",
2636
+ "properties": {
2637
+ "fullName": {
2638
+ "type": "string",
2639
+ "description": "Full legal name of the fund or group",
2640
+ "nullable": true
2641
+ },
2642
+ "domicile": {
2643
+ "type": "string",
2644
+ "description": "Country or jurisdiction of domicile",
2645
+ "nullable": true
2646
+ },
2647
+ "managementCompany": {
2648
+ "type": "string",
2649
+ "description": "Name of the management company",
2650
+ "nullable": true
2651
+ },
2652
+ "generalPartner": {
2653
+ "type": "string",
2654
+ "description": "Name of the general partner",
2655
+ "nullable": true
2656
+ },
2657
+ "vintageYear": {
2658
+ "type": "number",
2659
+ "description": "Vintage year",
2660
+ "nullable": true
2661
+ },
1223
2662
  "fundCurrency": {
1224
2663
  "type": "string",
1225
2664
  "description": "Fund currency (ISO 4217 code)",
@@ -1473,212 +2912,62 @@
1473
2912
  "isDemo"
1474
2913
  ]
1475
2914
  },
1476
- "SdkCompanyReferenceDto": {
1477
- "type": "object",
1478
- "properties": {
1479
- "id": {
1480
- "type": "number",
1481
- "description": "Company identifier"
1482
- },
1483
- "name": {
1484
- "type": "string",
1485
- "description": "Company display name"
1486
- },
1487
- "type": {
1488
- "type": "string",
1489
- "description": "Company type",
1490
- "nullable": true
1491
- }
1492
- },
1493
- "required": [
1494
- "id",
1495
- "name",
1496
- "type"
1497
- ]
1498
- },
1499
- "SdkCompanyGroupReferenceDto": {
1500
- "type": "object",
1501
- "properties": {
1502
- "id": {
1503
- "type": "number",
1504
- "description": "Company group identifier"
1505
- },
1506
- "name": {
1507
- "type": "string",
1508
- "description": "Company group name"
1509
- }
1510
- },
1511
- "required": [
1512
- "id",
1513
- "name"
1514
- ]
1515
- },
1516
- "SdkFairValueItemDto": {
1517
- "type": "object",
1518
- "properties": {
1519
- "id": {
1520
- "type": "number",
1521
- "description": "Fair value item identifier"
1522
- },
1523
- "companyGroupId": {
1524
- "type": "number",
1525
- "description": "Company group identifier"
1526
- },
1527
- "fairValue": {
1528
- "type": "number",
1529
- "description": "Fair value amount"
1530
- },
1531
- "type": {
1532
- "type": "string",
1533
- "description": "Transaction type",
1534
- "enum": [
1535
- "Auction",
1536
- "ConvertibleNote",
1537
- "ConvertToEquity",
1538
- "Dividend",
1539
- "EquityInvestment",
1540
- "EquityReceived",
1541
- "Extend",
1542
- "FutureEquityAgreement",
1543
- "Insolvency",
1544
- "IPO",
1545
- "LimitedAuction",
1546
- "OptionsReceived",
1547
- "OtherExit",
1548
- "OtherInvestment",
1549
- "OtherRealization",
1550
- "Payback",
1551
- "Proprietary",
1552
- "TradeSale",
1553
- "ValuationChange",
1554
- "WriteOff"
1555
- ]
1556
- }
1557
- },
1558
- "required": [
1559
- "id",
1560
- "companyGroupId",
1561
- "fairValue",
1562
- "type"
1563
- ]
1564
- },
1565
- "InvestorType": {
1566
- "type": "string",
1567
- "enum": [
1568
- "organization",
1569
- "individual"
1570
- ],
1571
- "description": "Investor type"
1572
- },
1573
- "SdkSignificantInvestorDto": {
1574
- "type": "object",
1575
- "properties": {
1576
- "investorType": {
1577
- "description": "Investor type",
1578
- "allOf": [
1579
- {
1580
- "$ref": "#/components/schemas/InvestorType"
1581
- }
1582
- ]
1583
- },
1584
- "name": {
1585
- "type": "string",
1586
- "description": "Investor name"
1587
- },
1588
- "lastName": {
1589
- "type": "string",
1590
- "description": "Investor last name"
1591
- },
1592
- "email": {
1593
- "type": "string",
1594
- "description": "Investor email"
1595
- },
1596
- "website": {
1597
- "type": "string",
1598
- "description": "Investor website"
1599
- }
1600
- },
1601
- "required": [
1602
- "investorType",
1603
- "name"
1604
- ]
1605
- },
1606
- "SdkFundingRoundInfoDto": {
1607
- "type": "object",
1608
- "properties": {
1609
- "roundType": {
1610
- "type": "string",
1611
- "description": "Funding round type",
1612
- "enum": [
1613
- "poc",
1614
- "pre-seed",
1615
- "seed",
1616
- "late-seed",
1617
- "seed-extension",
1618
- "pre-series-a-round",
1619
- "bridge-round",
1620
- "a-round",
1621
- "b-round",
1622
- "c-round",
1623
- "d-round-plus",
1624
- "d-round",
1625
- "e-round",
1626
- "f-round",
1627
- "g-round",
1628
- "h-round",
1629
- "i-round",
1630
- "j-round",
1631
- "k-round",
1632
- "l-round",
1633
- "m-round",
1634
- "n-round"
1635
- ],
1636
- "nullable": true
1637
- },
1638
- "roleInRound": {
1639
- "type": "string",
1640
- "description": "Role in the round",
1641
- "enum": [
1642
- "lead",
1643
- "co-lead",
1644
- "minority-co-investor",
1645
- "did-not-participate"
1646
- ],
1647
- "nullable": true
2915
+ "SdkLatestMetricValueDto": {
2916
+ "type": "object",
2917
+ "properties": {
2918
+ "metricTypeId": {
2919
+ "type": "number",
2920
+ "description": "Metric type identifier."
1648
2921
  },
1649
- "significantInvestors": {
1650
- "description": "Significant investors in the round",
1651
- "type": "array",
1652
- "items": {
1653
- "$ref": "#/components/schemas/SdkSignificantInvestorDto"
1654
- }
2922
+ "metricTypeName": {
2923
+ "type": "string",
2924
+ "description": "Metric type display name."
1655
2925
  },
1656
- "roundSize": {
2926
+ "value": {
1657
2927
  "type": "number",
1658
- "description": "Round size",
2928
+ "description": "Numeric value (null for option-valued metrics).",
1659
2929
  "nullable": true
1660
2930
  },
1661
- "totalFundingRaised": {
1662
- "type": "number",
1663
- "description": "Total funding raised at the round time",
2931
+ "optionValue": {
2932
+ "type": "string",
2933
+ "description": "String value for option-valued metrics (null for numeric metrics).",
1664
2934
  "nullable": true
2935
+ },
2936
+ "date": {
2937
+ "type": "string",
2938
+ "description": "Date of the data point (ISO 8601, YYYY-MM-DD)."
2939
+ },
2940
+ "unit": {
2941
+ "description": "Unit of measurement.",
2942
+ "nullable": true,
2943
+ "type": "object",
2944
+ "allOf": [
2945
+ {
2946
+ "$ref": "#/components/schemas/SdkMetricUnitDto"
2947
+ }
2948
+ ]
1665
2949
  }
1666
- }
2950
+ },
2951
+ "required": [
2952
+ "metricTypeId",
2953
+ "metricTypeName",
2954
+ "date"
2955
+ ]
1667
2956
  },
1668
- "SdkCompanyPositionDto": {
2957
+ "SdkPortfolioCompanySummaryDto": {
1669
2958
  "type": "object",
1670
2959
  "properties": {
1671
2960
  "companyId": {
1672
2961
  "type": "number",
1673
- "description": "Company identifier"
2962
+ "description": "Company identifier."
1674
2963
  },
1675
2964
  "companyGroupId": {
1676
2965
  "type": "number",
1677
- "description": "Company group identifier",
2966
+ "description": "Company group identifier.",
1678
2967
  "nullable": true
1679
2968
  },
1680
2969
  "company": {
1681
- "description": "Company reference",
2970
+ "description": "Company reference.",
1682
2971
  "allOf": [
1683
2972
  {
1684
2973
  "$ref": "#/components/schemas/SdkCompanyReferenceDto"
@@ -1686,7 +2975,7 @@
1686
2975
  ]
1687
2976
  },
1688
2977
  "companyGroup": {
1689
- "description": "Company group reference",
2978
+ "description": "Company group (fund) reference.",
1690
2979
  "allOf": [
1691
2980
  {
1692
2981
  "$ref": "#/components/schemas/SdkCompanyGroupReferenceDto"
@@ -1695,247 +2984,85 @@
1695
2984
  },
1696
2985
  "investmentStatus": {
1697
2986
  "type": "string",
1698
- "description": "Investment status",
2987
+ "description": "Investment status.",
1699
2988
  "nullable": true
1700
2989
  },
1701
2990
  "invested": {
1702
2991
  "type": "number",
1703
- "description": "Total invested amount"
1704
- },
1705
- "ownership": {
1706
- "type": "number",
1707
- "description": "Ownership percentage",
1708
- "nullable": true
1709
- },
1710
- "companyValuation": {
1711
- "type": "number",
1712
- "description": "Company valuation",
1713
- "nullable": true
1714
- },
1715
- "sharesOwnedTotal": {
1716
- "type": "number",
1717
- "description": "Number of units held"
1718
- },
1719
- "pricePerShare": {
1720
- "type": "number",
1721
- "description": "Price per share",
1722
- "nullable": true
1723
- },
1724
- "sharesIssuedTotalDiluted": {
1725
- "type": "number",
1726
- "description": "Total diluted shares issued"
1727
- },
1728
- "sharesIssuedTotalCurrent": {
1729
- "type": "number",
1730
- "description": "Total current shares issued"
1731
- },
1732
- "fairValueWithoutEquity": {
1733
- "type": "number",
1734
- "description": "Fair value excluding equity",
1735
- "nullable": true
2992
+ "description": "Total invested amount."
1736
2993
  },
1737
2994
  "fairValue": {
1738
2995
  "type": "number",
1739
- "description": "Position fair value",
2996
+ "description": "Position fair value.",
1740
2997
  "nullable": true
1741
2998
  },
1742
- "customSummaryFairValue": {
2999
+ "multiple": {
1743
3000
  "type": "number",
1744
- "description": "Custom fair value override applied at summary level",
3001
+ "description": "Investment multiple.",
1745
3002
  "nullable": true
1746
3003
  },
1747
- "askFairValue": {
1748
- "type": "boolean",
1749
- "description": "Whether a fair value input is required",
3004
+ "roi": {
3005
+ "type": "number",
3006
+ "description": "Return on investment.",
1750
3007
  "nullable": true
1751
3008
  },
1752
3009
  "xirr": {
1753
3010
  "type": "number",
1754
- "description": "Extended internal rate of return",
3011
+ "description": "Extended internal rate of return.",
1755
3012
  "nullable": true
1756
3013
  },
1757
- "roi": {
3014
+ "ownership": {
1758
3015
  "type": "number",
1759
- "description": "Return on investment",
3016
+ "description": "Ownership percentage.",
1760
3017
  "nullable": true
1761
3018
  },
1762
3019
  "realized": {
1763
3020
  "type": "number",
1764
- "description": "Realized amount",
1765
- "nullable": true
1766
- },
1767
- "investments": {
1768
- "type": "number",
1769
- "description": "Number of investments contributing to the position",
3021
+ "description": "Realized amount.",
1770
3022
  "nullable": true
1771
3023
  },
1772
- "defaultFairValueItems": {
1773
- "description": "Default fair value items",
3024
+ "latestMetrics": {
3025
+ "description": "Latest values for the requested metric types. Each entry carries the metric type id/name, latest value, date, and unit. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway when no metric types are specified.",
1774
3026
  "type": "array",
1775
3027
  "items": {
1776
- "$ref": "#/components/schemas/SdkFairValueItemDto"
3028
+ "$ref": "#/components/schemas/SdkLatestMetricValueDto"
1777
3029
  }
1778
3030
  },
1779
- "totalProfits": {
1780
- "type": "number",
1781
- "description": "Total profits",
1782
- "nullable": true
1783
- },
1784
- "exitProfits": {
1785
- "type": "number",
1786
- "description": "Exit profits",
1787
- "nullable": true
1788
- },
1789
- "equityFairValue": {
1790
- "type": "number",
1791
- "description": "Equity fair value",
1792
- "nullable": true
1793
- },
1794
- "multiple": {
1795
- "type": "number",
1796
- "description": "Investment multiple",
1797
- "nullable": true
1798
- },
1799
- "roundInfo": {
1800
- "description": "Funding round info",
1801
- "nullable": true,
1802
- "type": "object",
1803
- "allOf": [
1804
- {
1805
- "$ref": "#/components/schemas/SdkFundingRoundInfoDto"
1806
- }
1807
- ]
1808
- },
1809
- "valuationMethod": {
1810
- "type": "string",
1811
- "description": "Valuation method",
1812
- "enum": [
1813
- "Historical",
1814
- "NewFinancingRound",
1815
- "PubliclyListedSecurity",
1816
- "Realization",
1817
- "RecentTransactionMultiples",
1818
- "RecentMarketMultiples",
1819
- "RecentMarketAndTransactionMultiples",
1820
- "DiscountToPrimaryRound",
1821
- "ThirdPartyOpinion",
1822
- "Dcf",
1823
- "Other"
1824
- ],
1825
- "nullable": true
1826
- },
1827
- "totalFundingRaised": {
1828
- "type": "number",
1829
- "description": "Total funding raised",
1830
- "nullable": true
1831
- },
1832
- "averageInvestmentAmount": {
1833
- "type": "number",
1834
- "description": "Average investment amount",
1835
- "nullable": true
1836
- },
1837
- "investedInitial": {
1838
- "type": "number",
1839
- "description": "Initially invested amount",
1840
- "nullable": true
1841
- },
1842
- "investedFollowOn": {
1843
- "type": "number",
1844
- "description": "Follow-on invested amount",
1845
- "nullable": true
1846
- },
1847
- "dateOfInitialInvestment": {
1848
- "type": "string",
1849
- "description": "Initial investment date",
1850
- "nullable": true
1851
- },
1852
- "initialInvestmentStage": {
1853
- "type": "string",
1854
- "description": "Initial investment stage",
1855
- "enum": [
1856
- "poc",
1857
- "pre-seed",
1858
- "seed",
1859
- "late-seed",
1860
- "seed-extension",
1861
- "pre-series-a-round",
1862
- "bridge-round",
1863
- "a-round",
1864
- "b-round",
1865
- "c-round",
1866
- "d-round-plus",
1867
- "d-round",
1868
- "e-round",
1869
- "f-round",
1870
- "g-round",
1871
- "h-round",
1872
- "i-round",
1873
- "j-round",
1874
- "k-round",
1875
- "l-round",
1876
- "m-round",
1877
- "n-round"
1878
- ],
1879
- "nullable": true
1880
- },
1881
- "latestInvestment": {
1882
- "type": "number",
1883
- "description": "Latest investment amount",
1884
- "nullable": true
1885
- },
1886
- "dateOfLatestInvestment": {
1887
- "type": "string",
1888
- "description": "Latest investment date",
1889
- "nullable": true
1890
- },
1891
- "currentStage": {
1892
- "type": "string",
1893
- "description": "Current stage",
1894
- "enum": [
1895
- "poc",
1896
- "pre-seed",
1897
- "seed",
1898
- "late-seed",
1899
- "seed-extension",
1900
- "pre-series-a-round",
1901
- "bridge-round",
1902
- "a-round",
1903
- "b-round",
1904
- "c-round",
1905
- "d-round-plus",
1906
- "d-round",
1907
- "e-round",
1908
- "f-round",
1909
- "g-round",
1910
- "h-round",
1911
- "i-round",
1912
- "j-round",
1913
- "k-round",
1914
- "l-round",
1915
- "m-round",
1916
- "n-round"
1917
- ],
1918
- "nullable": true
1919
- },
1920
3031
  "currency": {
1921
3032
  "type": "string",
1922
- "description": "Reporting currency code"
3033
+ "description": "Reporting currency code."
1923
3034
  },
1924
3035
  "date": {
1925
3036
  "type": "string",
1926
- "description": "Position summary date"
3037
+ "description": "Position summary date (ISO 8601)."
1927
3038
  }
1928
3039
  },
1929
3040
  "required": [
1930
3041
  "companyId",
1931
3042
  "invested",
1932
- "sharesOwnedTotal",
1933
- "sharesIssuedTotalDiluted",
1934
- "sharesIssuedTotalCurrent",
3043
+ "latestMetrics",
1935
3044
  "currency",
1936
3045
  "date"
1937
3046
  ]
1938
3047
  },
3048
+ "SdkPortfolioSummaryListResponseDto": {
3049
+ "type": "object",
3050
+ "properties": {
3051
+ "data": {
3052
+ "type": "array",
3053
+ "items": {
3054
+ "$ref": "#/components/schemas/SdkPortfolioCompanySummaryDto"
3055
+ }
3056
+ },
3057
+ "meta": {
3058
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
3059
+ }
3060
+ },
3061
+ "required": [
3062
+ "data",
3063
+ "meta"
3064
+ ]
3065
+ },
1939
3066
  "SdkCompanyPositionsListResponseDto": {
1940
3067
  "type": "object",
1941
3068
  "properties": {
@@ -3538,6 +4665,109 @@
3538
4665
  "invested"
3539
4666
  ]
3540
4667
  },
4668
+ "SdkTransactionTypeSummaryDto": {
4669
+ "type": "object",
4670
+ "properties": {
4671
+ "type": {
4672
+ "type": "string",
4673
+ "description": "Transaction type.",
4674
+ "enum": [
4675
+ "Auction",
4676
+ "ConvertibleNote",
4677
+ "ConvertToEquity",
4678
+ "Dividend",
4679
+ "EquityInvestment",
4680
+ "EquityReceived",
4681
+ "Extend",
4682
+ "FutureEquityAgreement",
4683
+ "Insolvency",
4684
+ "IPO",
4685
+ "LimitedAuction",
4686
+ "OptionsReceived",
4687
+ "OtherExit",
4688
+ "OtherInvestment",
4689
+ "OtherRealization",
4690
+ "Payback",
4691
+ "Proprietary",
4692
+ "TradeSale",
4693
+ "ValuationChange",
4694
+ "WriteOff"
4695
+ ]
4696
+ },
4697
+ "count": {
4698
+ "type": "number",
4699
+ "description": "Number of transactions of this type."
4700
+ },
4701
+ "amount": {
4702
+ "type": "number",
4703
+ "description": "Total amount (invested or realized depending on type)."
4704
+ }
4705
+ },
4706
+ "required": [
4707
+ "type",
4708
+ "count",
4709
+ "amount"
4710
+ ]
4711
+ },
4712
+ "SdkTransactionSummaryPeriodDto": {
4713
+ "type": "object",
4714
+ "properties": {
4715
+ "period": {
4716
+ "type": "string",
4717
+ "description": "Period bucket key. When `groupBy` is provided, the period start date (ISO 8601, YYYY-MM-DD) — e.g. `2024-01-01` for `Year`/`Quarter`/`Month` buckets. When `groupBy` is omitted, the single aggregate bucket is reported as the literal string `\"total\"`.",
4718
+ "example": "2024-01-01"
4719
+ },
4720
+ "totalInvested": {
4721
+ "type": "number",
4722
+ "description": "Total amount invested across investment-type transactions."
4723
+ },
4724
+ "totalRealized": {
4725
+ "type": "number",
4726
+ "description": "Total amount realized across exit-type transactions."
4727
+ },
4728
+ "transactionCount": {
4729
+ "type": "number",
4730
+ "description": "Total number of transactions in this period."
4731
+ },
4732
+ "companyCount": {
4733
+ "type": "number",
4734
+ "description": "Number of distinct companies with transactions in this period."
4735
+ },
4736
+ "byType": {
4737
+ "description": "Breakdown by transaction type.",
4738
+ "type": "array",
4739
+ "items": {
4740
+ "$ref": "#/components/schemas/SdkTransactionTypeSummaryDto"
4741
+ }
4742
+ }
4743
+ },
4744
+ "required": [
4745
+ "period",
4746
+ "totalInvested",
4747
+ "totalRealized",
4748
+ "transactionCount",
4749
+ "companyCount",
4750
+ "byType"
4751
+ ]
4752
+ },
4753
+ "SdkTransactionSummaryResponseDto": {
4754
+ "type": "object",
4755
+ "properties": {
4756
+ "data": {
4757
+ "type": "array",
4758
+ "items": {
4759
+ "$ref": "#/components/schemas/SdkTransactionSummaryPeriodDto"
4760
+ }
4761
+ },
4762
+ "meta": {
4763
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
4764
+ }
4765
+ },
4766
+ "required": [
4767
+ "data",
4768
+ "meta"
4769
+ ]
4770
+ },
3541
4771
  "SdkTransactionsListResponseDto": {
3542
4772
  "type": "object",
3543
4773
  "properties": {
@@ -3600,67 +4830,321 @@
3600
4830
  }
3601
4831
  }
3602
4832
  },
3603
- "meta": {
3604
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
4833
+ "meta": {
4834
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
4835
+ }
4836
+ },
4837
+ "required": [
4838
+ "data",
4839
+ "meta"
4840
+ ]
4841
+ },
4842
+ "SdkMetricTypesListResponseDto": {
4843
+ "type": "object",
4844
+ "properties": {
4845
+ "data": {
4846
+ "type": "array",
4847
+ "items": {
4848
+ "$ref": "#/components/schemas/SdkMetricTypeDto"
4849
+ }
4850
+ },
4851
+ "meta": {
4852
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
4853
+ }
4854
+ },
4855
+ "required": [
4856
+ "data",
4857
+ "meta"
4858
+ ]
4859
+ },
4860
+ "MetricSearchDto": {
4861
+ "type": "object",
4862
+ "properties": {
4863
+ "limit": {
4864
+ "type": "number",
4865
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
4866
+ },
4867
+ "cursor": {
4868
+ "type": "string",
4869
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
4870
+ },
4871
+ "companyIds": {
4872
+ "description": "Restrict results to these companies. Defaults to all companies the caller can access.",
4873
+ "type": "array",
4874
+ "items": {
4875
+ "type": "number"
4876
+ }
4877
+ },
4878
+ "companyNameSearch": {
4879
+ "description": "Resolve companies by case-insensitive substring match on their display name. Pass an array to resolve multiple companies in one call — a company matches if its name contains ANY of the listed substrings (OR semantics). A single string is also accepted and treated as a one-element array. Intersects with `companyIds`/`companyGroupIds`. Lets the agent skip a separate /companies lookup when it only knows names.",
4880
+ "type": "array",
4881
+ "items": {
4882
+ "type": "string"
4883
+ }
4884
+ },
4885
+ "companyGroupIds": {
4886
+ "description": "Restrict to companies that belong to any of these company groups.",
4887
+ "type": "array",
4888
+ "items": {
4889
+ "type": "number"
4890
+ }
4891
+ },
4892
+ "metricTypeIds": {
4893
+ "description": "Restrict to specific metric types (use GET /metrics/types to discover identifiers).",
4894
+ "type": "array",
4895
+ "items": {
4896
+ "type": "number"
4897
+ }
4898
+ },
4899
+ "metricTypeNames": {
4900
+ "description": "Resolve metric types by case-insensitive exact match on their display name and intersect with `metricTypeIds`. Lets the agent fetch by metric name (e.g. \"Revenue\") without first listing /metrics/types.",
4901
+ "type": "array",
4902
+ "items": {
4903
+ "type": "string"
4904
+ }
4905
+ },
4906
+ "timeframe": {
4907
+ "type": "string",
4908
+ "description": "Restrict to a reporting period granularity.",
4909
+ "enum": [
4910
+ "Month",
4911
+ "Quarter",
4912
+ "Year"
4913
+ ]
4914
+ },
4915
+ "from": {
4916
+ "type": "string",
4917
+ "description": "Lower bound for point date (ISO 8601, inclusive)."
4918
+ },
4919
+ "to": {
4920
+ "type": "string",
4921
+ "description": "Upper bound for point date (ISO 8601, inclusive)."
4922
+ },
4923
+ "currency": {
4924
+ "type": "string",
4925
+ "description": "ISO 4217 currency code (e.g. USD, EUR). When set, monetary metrics are FX-converted to this currency and the metric type unit reports the target currency. Non-monetary metrics are unaffected."
4926
+ },
4927
+ "conversionStrategy": {
4928
+ "type": "string",
4929
+ "description": "FX rate selection when `currency` is set. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date. Ignored when `currency` is omitted.",
4930
+ "enum": [
4931
+ "LATEST_FX_RATE",
4932
+ "ENTITY_DATE_RATE"
4933
+ ]
4934
+ }
4935
+ }
4936
+ },
4937
+ "SdkCompanyMetricsDto": {
4938
+ "type": "object",
4939
+ "properties": {
4940
+ "companyId": {
4941
+ "type": "number",
4942
+ "description": "Company identifier."
4943
+ },
4944
+ "company": {
4945
+ "description": "Company reference with id and human-readable name.",
4946
+ "allOf": [
4947
+ {
4948
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
4949
+ }
4950
+ ]
4951
+ },
4952
+ "metrics": {
4953
+ "description": "Metrics reported for this company.",
4954
+ "type": "array",
4955
+ "items": {
4956
+ "$ref": "#/components/schemas/SdkCompanyMetricDto"
4957
+ }
4958
+ }
4959
+ },
4960
+ "required": [
4961
+ "companyId",
4962
+ "company",
4963
+ "metrics"
4964
+ ]
4965
+ },
4966
+ "SdkCompanyMetricsListResponseDto": {
4967
+ "type": "object",
4968
+ "properties": {
4969
+ "data": {
4970
+ "type": "array",
4971
+ "items": {
4972
+ "$ref": "#/components/schemas/SdkCompanyMetricsDto"
4973
+ }
4974
+ },
4975
+ "meta": {
4976
+ "$ref": "#/components/schemas/SdkPaginationMetaDto"
4977
+ }
4978
+ },
4979
+ "required": [
4980
+ "data",
4981
+ "meta"
4982
+ ]
4983
+ },
4984
+ "MetricCompareDto": {
4985
+ "type": "object",
4986
+ "properties": {
4987
+ "limit": {
4988
+ "type": "number",
4989
+ "description": "Maximum items per page. Currently accepted but not enforced; reserved for future pagination."
4990
+ },
4991
+ "cursor": {
4992
+ "type": "string",
4993
+ "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
4994
+ },
4995
+ "metricTypeIds": {
4996
+ "description": "Metric type identifiers to compare (resolve names to ids via /metrics/types). When multiple ids are provided, the response contains one entry per metric type.",
4997
+ "example": [
4998
+ 1,
4999
+ 7
5000
+ ],
5001
+ "type": "array",
5002
+ "items": {
5003
+ "type": "number"
5004
+ }
5005
+ },
5006
+ "companyIds": {
5007
+ "description": "Restrict to these company identifiers.",
5008
+ "type": "array",
5009
+ "items": {
5010
+ "type": "number"
5011
+ }
5012
+ },
5013
+ "companyNameSearch": {
5014
+ "description": "Case-insensitive substring match on company display name. Pass an array to compare multiple companies in one call — a company matches if its name contains ANY of the listed substrings (OR semantics). A single string is also accepted and treated as a one-element array. Intersects with `companyIds`/`companyGroupIds`.",
5015
+ "type": "array",
5016
+ "items": {
5017
+ "type": "string"
5018
+ }
5019
+ },
5020
+ "companyGroupIds": {
5021
+ "description": "Restrict to companies that belong to any of these company groups.",
5022
+ "type": "array",
5023
+ "items": {
5024
+ "type": "number"
5025
+ }
5026
+ },
5027
+ "timeframe": {
5028
+ "type": "string",
5029
+ "description": "Restrict to a reporting period granularity.",
5030
+ "enum": [
5031
+ "Month",
5032
+ "Quarter",
5033
+ "Year"
5034
+ ]
5035
+ },
5036
+ "from": {
5037
+ "type": "string",
5038
+ "description": "Lower bound for point date (ISO 8601, inclusive)."
5039
+ },
5040
+ "to": {
5041
+ "type": "string",
5042
+ "description": "Upper bound for point date (ISO 8601, inclusive)."
5043
+ },
5044
+ "currency": {
5045
+ "type": "string",
5046
+ "description": "ISO 4217 currency code. When set, monetary metrics are FX-converted to this target currency."
5047
+ },
5048
+ "conversionStrategy": {
5049
+ "type": "string",
5050
+ "description": "FX rate selection when `currency` is set. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date.",
5051
+ "enum": [
5052
+ "LATEST_FX_RATE",
5053
+ "ENTITY_DATE_RATE"
5054
+ ]
5055
+ },
5056
+ "includeChange": {
5057
+ "type": "boolean",
5058
+ "description": "Include period-over-period percentage change for each value.",
5059
+ "default": false
3605
5060
  }
3606
5061
  },
3607
5062
  "required": [
3608
- "data",
3609
- "meta"
5063
+ "metricTypeIds"
3610
5064
  ]
3611
5065
  },
3612
- "SdkMetricUnitDto": {
5066
+ "SdkMetricTypeReferenceDto": {
3613
5067
  "type": "object",
3614
5068
  "properties": {
3615
- "unit": {
3616
- "type": "object",
3617
- "description": "Unit category. Examples: \"Currency\", \"Percentage\", \"Number\", \"Day\", \"Month\", \"Quarter\", \"Year\"."
5069
+ "id": {
5070
+ "type": "number",
5071
+ "description": "Metric type identifier."
3618
5072
  },
3619
- "currencyCode": {
5073
+ "name": {
3620
5074
  "type": "string",
3621
- "description": "Currency code (ISO 4217), present only when the unit is \"Currency\".",
3622
- "nullable": true
5075
+ "description": "Metric type display name."
3623
5076
  }
3624
5077
  },
3625
5078
  "required": [
3626
- "unit"
5079
+ "id",
5080
+ "name"
3627
5081
  ]
3628
5082
  },
3629
- "SdkMetricTypeDto": {
5083
+ "SdkMetricCompareValueDto": {
3630
5084
  "type": "object",
3631
5085
  "properties": {
3632
- "id": {
5086
+ "companyId": {
3633
5087
  "type": "number",
3634
- "description": "Metric type identifier."
3635
- },
3636
- "name": {
3637
- "type": "string",
3638
- "description": "Metric type display name."
5088
+ "description": "Company identifier."
3639
5089
  },
3640
- "shortName": {
3641
- "type": "string",
3642
- "description": "Short display name / abbreviation.",
5090
+ "value": {
5091
+ "type": "number",
5092
+ "description": "Numeric value.",
3643
5093
  "nullable": true
3644
5094
  },
3645
- "description": {
5095
+ "optionValue": {
3646
5096
  "type": "string",
3647
- "description": "Free-form description of what the metric represents.",
5097
+ "description": "Option value for non-numeric metrics.",
3648
5098
  "nullable": true
3649
5099
  },
3650
- "origin": {
3651
- "type": "object",
3652
- "description": "Origin: predefined by Rundit or user-defined within the VC group."
5100
+ "change": {
5101
+ "type": "number",
5102
+ "description": "Period-over-period change as a decimal (e.g. 0.15 = +15%). Only present when `includeChange` is true.",
5103
+ "nullable": true
5104
+ }
5105
+ },
5106
+ "required": [
5107
+ "companyId"
5108
+ ]
5109
+ },
5110
+ "SdkMetricCompareRowDto": {
5111
+ "type": "object",
5112
+ "properties": {
5113
+ "date": {
5114
+ "type": "string",
5115
+ "description": "Period date (ISO 8601, YYYY-MM-DD)."
3653
5116
  },
3654
- "aggMethod": {
5117
+ "timeframe": {
3655
5118
  "type": "object",
3656
- "description": "How values aggregate across periods when rolled up (e.g. SUM, AVG, LAST_AVAILABLE, NONE)."
5119
+ "description": "Reporting period granularity."
3657
5120
  },
3658
- "valueType": {
3659
- "type": "object",
3660
- "description": "Value shape — \"numeric\" for measurements, \"option\" for enumerated choices."
5121
+ "values": {
5122
+ "description": "One entry per company with the metric value for this period.",
5123
+ "type": "array",
5124
+ "items": {
5125
+ "$ref": "#/components/schemas/SdkMetricCompareValueDto"
5126
+ }
5127
+ }
5128
+ },
5129
+ "required": [
5130
+ "date",
5131
+ "timeframe",
5132
+ "values"
5133
+ ]
5134
+ },
5135
+ "SdkMetricCompareResponseDto": {
5136
+ "type": "object",
5137
+ "properties": {
5138
+ "metricType": {
5139
+ "description": "The metric type being compared.",
5140
+ "allOf": [
5141
+ {
5142
+ "$ref": "#/components/schemas/SdkMetricTypeReferenceDto"
5143
+ }
5144
+ ]
3661
5145
  },
3662
5146
  "unit": {
3663
- "description": "Unit of measurement.",
5147
+ "description": "Unit of measurement (with currency code resolved when FX-converted).",
3664
5148
  "nullable": true,
3665
5149
  "type": "object",
3666
5150
  "allOf": [
@@ -3668,33 +5152,44 @@
3668
5152
  "$ref": "#/components/schemas/SdkMetricUnitDto"
3669
5153
  }
3670
5154
  ]
5155
+ },
5156
+ "companies": {
5157
+ "description": "Companies included in the comparison.",
5158
+ "type": "array",
5159
+ "items": {
5160
+ "$ref": "#/components/schemas/SdkCompanyReferenceDto"
5161
+ }
5162
+ },
5163
+ "rows": {
5164
+ "description": "Date-aligned rows. Each row contains one value per company for a given period.",
5165
+ "type": "array",
5166
+ "items": {
5167
+ "$ref": "#/components/schemas/SdkMetricCompareRowDto"
5168
+ }
3671
5169
  }
3672
5170
  },
3673
5171
  "required": [
3674
- "id",
3675
- "name",
3676
- "aggMethod"
5172
+ "metricType",
5173
+ "companies",
5174
+ "rows"
3677
5175
  ]
3678
5176
  },
3679
- "SdkMetricTypesListResponseDto": {
5177
+ "SdkMetricCompareMultiResponseDto": {
3680
5178
  "type": "object",
3681
5179
  "properties": {
3682
- "data": {
5180
+ "comparisons": {
5181
+ "description": "One comparison result per requested metric type.",
3683
5182
  "type": "array",
3684
5183
  "items": {
3685
- "$ref": "#/components/schemas/SdkMetricTypeDto"
5184
+ "$ref": "#/components/schemas/SdkMetricCompareResponseDto"
3686
5185
  }
3687
- },
3688
- "meta": {
3689
- "$ref": "#/components/schemas/SdkPaginationMetaDto"
3690
5186
  }
3691
5187
  },
3692
5188
  "required": [
3693
- "data",
3694
- "meta"
5189
+ "comparisons"
3695
5190
  ]
3696
5191
  },
3697
- "MetricSearchDto": {
5192
+ "MetricAggregateDto": {
3698
5193
  "type": "object",
3699
5194
  "properties": {
3700
5195
  "limit": {
@@ -3705,22 +5200,38 @@
3705
5200
  "type": "string",
3706
5201
  "description": "Opaque cursor from a previous response's meta.nextCursor. Currently accepted but ignored."
3707
5202
  },
3708
- "companyIds": {
3709
- "description": "Restrict results to these companies. Defaults to all companies the caller can access.",
5203
+ "metricTypeIds": {
5204
+ "description": "Metric type identifiers to aggregate. Resolve names to ids via /metrics/types.",
5205
+ "example": [
5206
+ 1,
5207
+ 7
5208
+ ],
3710
5209
  "type": "array",
3711
5210
  "items": {
3712
5211
  "type": "number"
3713
5212
  }
3714
5213
  },
3715
- "companyGroupIds": {
3716
- "description": "Restrict to companies that belong to any of these company groups.",
5214
+ "aggregation": {
5215
+ "type": "string",
5216
+ "description": "Aggregation function to apply across companies for each period.",
5217
+ "enum": [
5218
+ "SUM",
5219
+ "AVG",
5220
+ "MEDIAN",
5221
+ "MIN",
5222
+ "MAX",
5223
+ "COUNT"
5224
+ ]
5225
+ },
5226
+ "companyIds": {
5227
+ "description": "Restrict to these company identifiers.",
3717
5228
  "type": "array",
3718
5229
  "items": {
3719
5230
  "type": "number"
3720
5231
  }
3721
5232
  },
3722
- "metricTypeIds": {
3723
- "description": "Restrict to specific metric types (use GET /metrics/types to discover identifiers).",
5233
+ "companyGroupIds": {
5234
+ "description": "Restrict to companies that belong to any of these company groups.",
3724
5235
  "type": "array",
3725
5236
  "items": {
3726
5237
  "type": "number"
@@ -3742,15 +5253,36 @@
3742
5253
  "to": {
3743
5254
  "type": "string",
3744
5255
  "description": "Upper bound for point date (ISO 8601, inclusive)."
5256
+ },
5257
+ "currency": {
5258
+ "type": "string",
5259
+ "description": "ISO 4217 currency code. When set, monetary metrics are FX-converted to this target currency."
5260
+ },
5261
+ "conversionStrategy": {
5262
+ "type": "string",
5263
+ "description": "FX rate selection when `currency` is set. `LATEST_FX_RATE` (default) uses the most recent rate; `ENTITY_DATE_RATE` uses the rate on each point's date.",
5264
+ "enum": [
5265
+ "LATEST_FX_RATE",
5266
+ "ENTITY_DATE_RATE"
5267
+ ]
5268
+ },
5269
+ "groupByCompanyGroup": {
5270
+ "type": "boolean",
5271
+ "description": "When true, results are grouped by company group. Each metric type produces one entry per company group.",
5272
+ "default": false
3745
5273
  }
3746
- }
5274
+ },
5275
+ "required": [
5276
+ "metricTypeIds",
5277
+ "aggregation"
5278
+ ]
3747
5279
  },
3748
- "SdkMetricPointDto": {
5280
+ "SdkAggregatedPointDto": {
3749
5281
  "type": "object",
3750
5282
  "properties": {
3751
5283
  "date": {
3752
5284
  "type": "string",
3753
- "description": "Period end date (ISO 8601, YYYY-MM-DD)."
5285
+ "description": "Period date (ISO 8601, YYYY-MM-DD)."
3754
5286
  },
3755
5287
  "timeframe": {
3756
5288
  "type": "object",
@@ -3758,90 +5290,85 @@
3758
5290
  },
3759
5291
  "value": {
3760
5292
  "type": "number",
3761
- "description": "Reported value for the period. Null when the value could not be computed.",
3762
- "nullable": true
3763
- },
3764
- "valueError": {
3765
- "type": "string",
3766
- "description": "Computation error message, if the value could not be calculated.",
5293
+ "description": "Aggregated value for the period. Null when the metric type does not enable the requested aggregation (SUM/AVG/MEDIAN are gated by the metric type configuration; MIN/MAX/COUNT are always available).",
3767
5294
  "nullable": true
3768
5295
  },
3769
- "aggregated": {
3770
- "type": "boolean",
3771
- "description": "True when the point is derived (e.g. aggregated from sub-rows) rather than directly stored."
5296
+ "companyCount": {
5297
+ "type": "number",
5298
+ "description": "Number of companies that contributed a data point for this period."
3772
5299
  }
3773
5300
  },
3774
5301
  "required": [
3775
5302
  "date",
3776
5303
  "timeframe",
3777
- "value"
5304
+ "value",
5305
+ "companyCount"
3778
5306
  ]
3779
5307
  },
3780
- "SdkCompanyMetricDto": {
5308
+ "SdkAggregatedMetricDto": {
3781
5309
  "type": "object",
3782
5310
  "properties": {
3783
- "id": {
3784
- "type": "number",
3785
- "description": "Metric instance identifier (unique per company)."
3786
- },
3787
5311
  "metricType": {
3788
- "description": "Metric type definition.",
5312
+ "description": "Metric type reference.",
3789
5313
  "allOf": [
3790
5314
  {
3791
- "$ref": "#/components/schemas/SdkMetricTypeDto"
5315
+ "$ref": "#/components/schemas/SdkMetricTypeReferenceDto"
3792
5316
  }
3793
5317
  ]
3794
5318
  },
3795
- "points": {
3796
- "description": "Reported data points for this metric.",
3797
- "type": "array",
3798
- "items": {
3799
- "$ref": "#/components/schemas/SdkMetricPointDto"
3800
- }
3801
- }
3802
- },
3803
- "required": [
3804
- "id",
3805
- "metricType",
3806
- "points"
3807
- ]
3808
- },
3809
- "SdkCompanyMetricsDto": {
3810
- "type": "object",
3811
- "properties": {
3812
- "companyId": {
3813
- "type": "number",
3814
- "description": "Company identifier."
5319
+ "unit": {
5320
+ "description": "Unit of measurement (with currency code resolved when FX-converted).",
5321
+ "nullable": true,
5322
+ "type": "object",
5323
+ "allOf": [
5324
+ {
5325
+ "$ref": "#/components/schemas/SdkMetricUnitDto"
5326
+ }
5327
+ ]
3815
5328
  },
3816
- "company": {
3817
- "description": "Company reference with id and human-readable name.",
5329
+ "aggregation": {
5330
+ "type": "string",
5331
+ "description": "Aggregation function applied.",
5332
+ "enum": [
5333
+ "SUM",
5334
+ "AVG",
5335
+ "MEDIAN",
5336
+ "MIN",
5337
+ "MAX",
5338
+ "COUNT"
5339
+ ]
5340
+ },
5341
+ "companyGroup": {
5342
+ "description": "Company group reference when `groupByCompanyGroup` is true.",
5343
+ "nullable": true,
5344
+ "type": "object",
3818
5345
  "allOf": [
3819
5346
  {
3820
- "$ref": "#/components/schemas/SdkCompanyReferenceDto"
5347
+ "$ref": "#/components/schemas/SdkCompanyGroupReferenceDto"
3821
5348
  }
3822
5349
  ]
3823
5350
  },
3824
- "metrics": {
3825
- "description": "Metrics reported for this company.",
5351
+ "points": {
5352
+ "description": "Aggregated data points ordered by date ascending.",
3826
5353
  "type": "array",
3827
5354
  "items": {
3828
- "$ref": "#/components/schemas/SdkCompanyMetricDto"
5355
+ "$ref": "#/components/schemas/SdkAggregatedPointDto"
3829
5356
  }
3830
5357
  }
3831
5358
  },
3832
5359
  "required": [
3833
- "companyId",
3834
- "company",
3835
- "metrics"
5360
+ "metricType",
5361
+ "aggregation",
5362
+ "points"
3836
5363
  ]
3837
5364
  },
3838
- "SdkCompanyMetricsListResponseDto": {
5365
+ "SdkMetricAggregateResponseDto": {
3839
5366
  "type": "object",
3840
5367
  "properties": {
3841
5368
  "data": {
3842
5369
  "type": "array",
3843
5370
  "items": {
3844
- "$ref": "#/components/schemas/SdkCompanyMetricsDto"
5371
+ "$ref": "#/components/schemas/SdkAggregatedMetricDto"
3845
5372
  }
3846
5373
  },
3847
5374
  "meta": {
@@ -3853,47 +5380,6 @@
3853
5380
  "meta"
3854
5381
  ]
3855
5382
  },
3856
- "SdkCompanyReportSummaryDto": {
3857
- "type": "object",
3858
- "properties": {
3859
- "id": {
3860
- "type": "number",
3861
- "description": "Report identifier."
3862
- },
3863
- "title": {
3864
- "type": "string",
3865
- "description": "Human-readable report title."
3866
- },
3867
- "date": {
3868
- "type": "string",
3869
- "description": "Reporting period end date (ISO 8601, YYYY-MM-DD)."
3870
- },
3871
- "timeframe": {
3872
- "type": "object",
3873
- "description": "Reporting period granularity."
3874
- },
3875
- "publishedAt": {
3876
- "type": "string",
3877
- "description": "When the report was published (ISO 8601).",
3878
- "nullable": true
3879
- },
3880
- "company": {
3881
- "description": "Company that published the report.",
3882
- "allOf": [
3883
- {
3884
- "$ref": "#/components/schemas/SdkCompanyReferenceDto"
3885
- }
3886
- ]
3887
- }
3888
- },
3889
- "required": [
3890
- "id",
3891
- "title",
3892
- "date",
3893
- "timeframe",
3894
- "company"
3895
- ]
3896
- },
3897
5383
  "SdkCompanyReportsListResponseDto": {
3898
5384
  "type": "object",
3899
5385
  "properties": {