@rundit-sdk/embed 0.3.3 → 0.3.4
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/AGENTS.md +2 -1
- package/README.md +2 -1
- package/ai-manifest.json +43 -30
- package/dist/index.d.ts +55 -43
- package/dist/index.js +44 -31
- package/openapi.json +85 -42
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -88,8 +88,9 @@ console.log(routeManifest)
|
|
|
88
88
|
## metrics
|
|
89
89
|
|
|
90
90
|
- metrics.getTypes: List metric types available to the SDK consumer
|
|
91
|
-
- Call: `client.metrics.getTypes()`
|
|
91
|
+
- Call: `client.metrics.getTypes({ limit: 123 })`
|
|
92
92
|
- Returns: `MetricsGetTypesResponse`
|
|
93
|
+
- Params: query: limit? (number), cursor? (string)
|
|
93
94
|
- metrics.search: Read metric values for accessible companies, grouped by company
|
|
94
95
|
- Call: `client.metrics.search({})`
|
|
95
96
|
- Returns: `MetricsSearchResponse`
|
package/README.md
CHANGED
|
@@ -164,9 +164,10 @@ Get transactions for multiple companies
|
|
|
164
164
|
|
|
165
165
|
List metric types available to the SDK consumer
|
|
166
166
|
|
|
167
|
-
- Call: `client.metrics.getTypes()`
|
|
167
|
+
- Call: `client.metrics.getTypes({ limit: 123 })`
|
|
168
168
|
- HTTP: `GET /metrics/types`
|
|
169
169
|
- Returns: `MetricsGetTypesResponse`
|
|
170
|
+
- Params: query: limit? (number), cursor? (string)
|
|
170
171
|
|
|
171
172
|
### `metrics.search`
|
|
172
173
|
|
package/ai-manifest.json
CHANGED
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
{
|
|
24
24
|
"operation": "getDashboards",
|
|
25
25
|
"summary": "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call",
|
|
26
|
-
"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).",
|
|
26
|
+
"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). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.",
|
|
27
27
|
"method": "POST",
|
|
28
28
|
"path": "/companies/dashboards",
|
|
29
29
|
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
@@ -93,7 +93,7 @@
|
|
|
93
93
|
{
|
|
94
94
|
"operation": "getAll",
|
|
95
95
|
"summary": "List companies available to the SDK consumer",
|
|
96
|
-
"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.",
|
|
96
|
+
"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. Ordered by company id ascending.",
|
|
97
97
|
"method": "GET",
|
|
98
98
|
"path": "/companies",
|
|
99
99
|
"exampleCall": "client.companies.getAll({ limit: 123 })",
|
|
@@ -104,13 +104,13 @@
|
|
|
104
104
|
"name": "limit",
|
|
105
105
|
"required": false,
|
|
106
106
|
"type": "number",
|
|
107
|
-
"description": "Maximum items per page.
|
|
107
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
108
108
|
},
|
|
109
109
|
{
|
|
110
110
|
"name": "cursor",
|
|
111
111
|
"required": false,
|
|
112
112
|
"type": "string",
|
|
113
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
113
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
114
114
|
},
|
|
115
115
|
{
|
|
116
116
|
"name": "companyIds",
|
|
@@ -137,7 +137,7 @@
|
|
|
137
137
|
{
|
|
138
138
|
"operation": "getAll",
|
|
139
139
|
"summary": "List funds available to the SDK consumer",
|
|
140
|
-
"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\"]`).",
|
|
140
|
+
"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\"]`). Ordered by fund id ascending.",
|
|
141
141
|
"method": "GET",
|
|
142
142
|
"path": "/company-groups",
|
|
143
143
|
"exampleCall": "client.companyGroups.getAll({ limit: 123 })",
|
|
@@ -148,13 +148,13 @@
|
|
|
148
148
|
"name": "limit",
|
|
149
149
|
"required": false,
|
|
150
150
|
"type": "number",
|
|
151
|
-
"description": "Maximum items per page.
|
|
151
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
152
152
|
},
|
|
153
153
|
{
|
|
154
154
|
"name": "cursor",
|
|
155
155
|
"required": false,
|
|
156
156
|
"type": "string",
|
|
157
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
157
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
158
158
|
},
|
|
159
159
|
{
|
|
160
160
|
"name": "companyGroupIds",
|
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
{
|
|
193
193
|
"operation": "getPortfolioSummary",
|
|
194
194
|
"summary": "Get portfolio summary with positions and key metrics per company",
|
|
195
|
-
"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.",
|
|
195
|
+
"description": "Returns one row per company *per fund* — a company held by two funds appears twice, distinguished by `companyGroupId` — 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. Ordered by company id, then fund id.",
|
|
196
196
|
"method": "GET",
|
|
197
197
|
"path": "/positions/portfolio/summary",
|
|
198
198
|
"exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
|
|
@@ -203,13 +203,13 @@
|
|
|
203
203
|
"name": "limit",
|
|
204
204
|
"required": false,
|
|
205
205
|
"type": "number",
|
|
206
|
-
"description": "Maximum items per page.
|
|
206
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
207
207
|
},
|
|
208
208
|
{
|
|
209
209
|
"name": "cursor",
|
|
210
210
|
"required": false,
|
|
211
211
|
"type": "string",
|
|
212
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
212
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
213
213
|
},
|
|
214
214
|
{
|
|
215
215
|
"name": "companyGroupIds",
|
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
{
|
|
247
247
|
"operation": "getCompanyPositions",
|
|
248
248
|
"summary": "Get positions for one company",
|
|
249
|
-
"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.",
|
|
249
|
+
"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. Ordered by fund id ascending.",
|
|
250
250
|
"method": "GET",
|
|
251
251
|
"path": "/positions/companies/:id",
|
|
252
252
|
"exampleCall": "client.positions.getCompanyPositions(123, { currency: 'USD' })",
|
|
@@ -263,13 +263,13 @@
|
|
|
263
263
|
"name": "limit",
|
|
264
264
|
"required": false,
|
|
265
265
|
"type": "number",
|
|
266
|
-
"description": "Maximum items per page.
|
|
266
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
267
267
|
},
|
|
268
268
|
{
|
|
269
269
|
"name": "cursor",
|
|
270
270
|
"required": false,
|
|
271
271
|
"type": "string",
|
|
272
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
272
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
273
273
|
},
|
|
274
274
|
{
|
|
275
275
|
"name": "companyGroupIds",
|
|
@@ -332,7 +332,7 @@
|
|
|
332
332
|
{
|
|
333
333
|
"operation": "getSummary",
|
|
334
334
|
"summary": "Get transaction activity summary",
|
|
335
|
-
"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.",
|
|
335
|
+
"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. Ordered by period ascending.",
|
|
336
336
|
"method": "GET",
|
|
337
337
|
"path": "/transactions/summary",
|
|
338
338
|
"exampleCall": "client.transactions.getSummary({ currency: 'USD' })",
|
|
@@ -343,13 +343,13 @@
|
|
|
343
343
|
"name": "limit",
|
|
344
344
|
"required": false,
|
|
345
345
|
"type": "number",
|
|
346
|
-
"description": "Maximum items per page.
|
|
346
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
347
347
|
},
|
|
348
348
|
{
|
|
349
349
|
"name": "cursor",
|
|
350
350
|
"required": false,
|
|
351
351
|
"type": "string",
|
|
352
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
352
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
353
353
|
},
|
|
354
354
|
{
|
|
355
355
|
"name": "companyGroupIds",
|
|
@@ -392,7 +392,7 @@
|
|
|
392
392
|
{
|
|
393
393
|
"operation": "getCompanyTransactions",
|
|
394
394
|
"summary": "Get transactions for one company",
|
|
395
|
-
"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.",
|
|
395
|
+
"description": "Returns all transactions for a single company, ordered by date descending then id 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.",
|
|
396
396
|
"method": "GET",
|
|
397
397
|
"path": "/transactions/companies/:id",
|
|
398
398
|
"exampleCall": "client.transactions.getCompanyTransactions(123, { limit: 123 })",
|
|
@@ -409,13 +409,13 @@
|
|
|
409
409
|
"name": "limit",
|
|
410
410
|
"required": false,
|
|
411
411
|
"type": "number",
|
|
412
|
-
"description": "Maximum items per page.
|
|
412
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
413
413
|
},
|
|
414
414
|
{
|
|
415
415
|
"name": "cursor",
|
|
416
416
|
"required": false,
|
|
417
417
|
"type": "string",
|
|
418
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
418
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
419
419
|
},
|
|
420
420
|
{
|
|
421
421
|
"name": "companyGroupIds",
|
|
@@ -440,7 +440,7 @@
|
|
|
440
440
|
{
|
|
441
441
|
"operation": "getTransactions",
|
|
442
442
|
"summary": "Get transactions for multiple companies",
|
|
443
|
-
"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.",
|
|
443
|
+
"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. Ordered by date descending, then id descending.",
|
|
444
444
|
"method": "GET",
|
|
445
445
|
"path": "/transactions",
|
|
446
446
|
"exampleCall": "client.transactions.getTransactions({ limit: 123 })",
|
|
@@ -451,13 +451,13 @@
|
|
|
451
451
|
"name": "limit",
|
|
452
452
|
"required": false,
|
|
453
453
|
"type": "number",
|
|
454
|
-
"description": "Maximum items per page.
|
|
454
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
455
455
|
},
|
|
456
456
|
{
|
|
457
457
|
"name": "cursor",
|
|
458
458
|
"required": false,
|
|
459
459
|
"type": "string",
|
|
460
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
460
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
461
461
|
},
|
|
462
462
|
{
|
|
463
463
|
"name": "companyGroupIds",
|
|
@@ -490,18 +490,31 @@
|
|
|
490
490
|
{
|
|
491
491
|
"operation": "getTypes",
|
|
492
492
|
"summary": "List metric types available to the SDK consumer",
|
|
493
|
-
"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.",
|
|
493
|
+
"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. Ordered by metric type id ascending.",
|
|
494
494
|
"method": "GET",
|
|
495
495
|
"path": "/metrics/types",
|
|
496
|
-
"exampleCall": "client.metrics.getTypes()",
|
|
496
|
+
"exampleCall": "client.metrics.getTypes({ limit: 123 })",
|
|
497
497
|
"responseType": "MetricsGetTypesResponse",
|
|
498
498
|
"pathParams": [],
|
|
499
|
-
"queryParams": [
|
|
499
|
+
"queryParams": [
|
|
500
|
+
{
|
|
501
|
+
"name": "limit",
|
|
502
|
+
"required": false,
|
|
503
|
+
"type": "number",
|
|
504
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "cursor",
|
|
508
|
+
"required": false,
|
|
509
|
+
"type": "string",
|
|
510
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
511
|
+
}
|
|
512
|
+
]
|
|
500
513
|
},
|
|
501
514
|
{
|
|
502
515
|
"operation": "search",
|
|
503
516
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
504
|
-
"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.",
|
|
517
|
+
"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. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
505
518
|
"method": "POST",
|
|
506
519
|
"path": "/metrics",
|
|
507
520
|
"exampleCall": "client.metrics.search({})",
|
|
@@ -523,7 +536,7 @@
|
|
|
523
536
|
{
|
|
524
537
|
"operation": "aggregate",
|
|
525
538
|
"summary": "Aggregate metrics across portfolio companies",
|
|
526
|
-
"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.",
|
|
539
|
+
"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. Ordered by metric type id, then aggregation, then fund id.",
|
|
527
540
|
"method": "POST",
|
|
528
541
|
"path": "/metrics/aggregate",
|
|
529
542
|
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
|
@@ -536,7 +549,7 @@
|
|
|
536
549
|
{
|
|
537
550
|
"operation": "list",
|
|
538
551
|
"summary": "List published company reports accessible to the caller (metadata only)",
|
|
539
|
-
"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).",
|
|
552
|
+
"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). Ordered by report date descending, then id descending — newest first.",
|
|
540
553
|
"method": "GET",
|
|
541
554
|
"path": "/company-reports",
|
|
542
555
|
"exampleCall": "client.companyReports.list({ limit: 123 })",
|
|
@@ -547,13 +560,13 @@
|
|
|
547
560
|
"name": "limit",
|
|
548
561
|
"required": false,
|
|
549
562
|
"type": "number",
|
|
550
|
-
"description": "Maximum items per page.
|
|
563
|
+
"description": "Maximum items per page (1-500). Omit to receive the full result set in one response. Values outside that range are rejected with 422 rather than clamped, so a page is never quietly smaller than requested."
|
|
551
564
|
},
|
|
552
565
|
{
|
|
553
566
|
"name": "cursor",
|
|
554
567
|
"required": false,
|
|
555
568
|
"type": "string",
|
|
556
|
-
"description": "Opaque cursor from a previous response's meta.nextCursor.
|
|
569
|
+
"description": "Opaque cursor from a previous response's `meta.nextCursor`. Carries the page size it was issued with, so a follow-up call needs only the cursor. Valid solely for the endpoint, filters, and caller that produced it — change any of them and you get 422; start again without a cursor. Paging reflects the data as of each request, so rows added or removed mid-walk can shift positions."
|
|
557
570
|
},
|
|
558
571
|
{
|
|
559
572
|
"name": "companyIds",
|