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

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