@rundit-sdk/embed 0.3.4 → 0.3.5-rc.14
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/ai-manifest.json +7 -7
- package/dist/index.d.ts +14 -13
- package/dist/index.js +7 -7
- package/openapi.json +135 -10
- package/package.json +1 -1
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). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.",
|
|
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` (case-insensitive exact match on full name or `shortName`) 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' })",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
{
|
|
77
77
|
"operation": "getOne",
|
|
78
78
|
"summary": "Get one company available to the SDK consumer",
|
|
79
|
-
"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
|
|
79
|
+
"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 403 (not 404) both when the company does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /companies` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
80
80
|
"method": "GET",
|
|
81
81
|
"path": "/companies/:id",
|
|
82
82
|
"exampleCall": "client.companies.getOne(123)",
|
|
@@ -173,7 +173,7 @@
|
|
|
173
173
|
{
|
|
174
174
|
"operation": "getOne",
|
|
175
175
|
"summary": "Get one fund available to the SDK consumer",
|
|
176
|
-
"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
|
|
176
|
+
"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 403 (not 404) both when the fund does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /company-groups` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
177
177
|
"method": "GET",
|
|
178
178
|
"path": "/company-groups/:id",
|
|
179
179
|
"exampleCall": "client.companyGroups.getOne(123)",
|
|
@@ -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 *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
|
|
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` (case-insensitive exact match on full name or `shortName`). 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' })",
|
|
@@ -239,7 +239,7 @@
|
|
|
239
239
|
"name": "metricTypeNames",
|
|
240
240
|
"required": false,
|
|
241
241
|
"type": "string[]",
|
|
242
|
-
"description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway."
|
|
242
|
+
"description": "Metric type names to include in the latest metrics snapshot (case-insensitive exact match on display name or `shortName`). Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Names that match no accessible metric type are ignored."
|
|
243
243
|
}
|
|
244
244
|
]
|
|
245
245
|
},
|
|
@@ -514,7 +514,7 @@
|
|
|
514
514
|
{
|
|
515
515
|
"operation": "search",
|
|
516
516
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
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.",
|
|
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` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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.",
|
|
518
518
|
"method": "POST",
|
|
519
519
|
"path": "/metrics",
|
|
520
520
|
"exampleCall": "client.metrics.search({})",
|
|
@@ -536,7 +536,7 @@
|
|
|
536
536
|
{
|
|
537
537
|
"operation": "aggregate",
|
|
538
538
|
"summary": "Aggregate metrics across portfolio companies",
|
|
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.
|
|
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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so \"no data\" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then by the order of the requested `metricTypeIds`.",
|
|
540
540
|
"method": "POST",
|
|
541
541
|
"path": "/metrics/aggregate",
|
|
542
542
|
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
package/dist/index.d.ts
CHANGED
|
@@ -681,6 +681,7 @@ export interface MetricAggregateDto {
|
|
|
681
681
|
metricTypeIds: number[]
|
|
682
682
|
aggregation: "SUM" | "AVG" | "MEDIAN" | "MIN" | "MAX" | "COUNT"
|
|
683
683
|
companyIds?: number[]
|
|
684
|
+
companyNameSearch?: string[]
|
|
684
685
|
companyGroupIds?: number[]
|
|
685
686
|
timeframe?: "Month" | "Quarter" | "Year"
|
|
686
687
|
from?: string
|
|
@@ -910,7 +911,7 @@ export interface PositionsGetPortfolioSummaryQuery {
|
|
|
910
911
|
*/
|
|
911
912
|
date?: string
|
|
912
913
|
/**
|
|
913
|
-
* Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway.
|
|
914
|
+
* Metric type names to include in the latest metrics snapshot (case-insensitive exact match on display name or `shortName`). Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Names that match no accessible metric type are ignored.
|
|
914
915
|
*/
|
|
915
916
|
metricTypeNames?: string[]
|
|
916
917
|
}
|
|
@@ -1091,7 +1092,7 @@ export interface CompanyReportsListQuery {
|
|
|
1091
1092
|
export interface CompaniesNamespace {
|
|
1092
1093
|
/**
|
|
1093
1094
|
* PREFERRED tool for multi-company analysis — full dashboards for many companies in one call
|
|
1094
|
-
* 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.
|
|
1095
|
+
* 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` (case-insensitive exact match on full name or `shortName`) 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.
|
|
1095
1096
|
* Parameters: body: CompaniesGetDashboardsBody
|
|
1096
1097
|
* Returns: CompaniesGetDashboardsResponse
|
|
1097
1098
|
*/
|
|
@@ -1105,7 +1106,7 @@ export interface CompaniesNamespace {
|
|
|
1105
1106
|
getDashboard(id: number, query?: CompaniesGetDashboardQuery, init?: RequestOptions): Promise<CompaniesGetDashboardResponse>
|
|
1106
1107
|
/**
|
|
1107
1108
|
* Get one company available to the SDK consumer
|
|
1108
|
-
* 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
|
|
1109
|
+
* 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 403 (not 404) both when the company does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /companies` first. (A missing API key scope also yields 403, with an "Insufficient API key scopes" message.)
|
|
1109
1110
|
* Parameters: path: id (number)
|
|
1110
1111
|
* Returns: CompaniesGetOneResponse
|
|
1111
1112
|
*/
|
|
@@ -1129,7 +1130,7 @@ export interface CompanyGroupsNamespace {
|
|
|
1129
1130
|
getAll(query?: CompanyGroupsGetAllQuery, init?: RequestOptions): Promise<CompanyGroupsGetAllResponse>
|
|
1130
1131
|
/**
|
|
1131
1132
|
* Get one fund available to the SDK consumer
|
|
1132
|
-
* 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
|
|
1133
|
+
* 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 403 (not 404) both when the fund does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /company-groups` first. (A missing API key scope also yields 403, with an "Insufficient API key scopes" message.)
|
|
1133
1134
|
* Parameters: path: id (number)
|
|
1134
1135
|
* Returns: CompanyGroupsGetOneResponse
|
|
1135
1136
|
*/
|
|
@@ -1139,7 +1140,7 @@ export interface CompanyGroupsNamespace {
|
|
|
1139
1140
|
export interface PositionsNamespace {
|
|
1140
1141
|
/**
|
|
1141
1142
|
* Get portfolio summary with positions and key metrics per company
|
|
1142
|
-
* 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
|
|
1143
|
+
* 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` (case-insensitive exact match on full name or `shortName`). Designed for portfolio overview tables. Ordered by company id, then fund id.
|
|
1143
1144
|
* Parameters: query: limit? (number), cursor? (string), companyGroupIds? (number[]), companyIds? (number[]), currency (string), date? (string), metricTypeNames? (string[])
|
|
1144
1145
|
* Returns: PositionsGetPortfolioSummaryResponse
|
|
1145
1146
|
*/
|
|
@@ -1194,7 +1195,7 @@ export interface MetricsNamespace {
|
|
|
1194
1195
|
getTypes(query?: MetricsGetTypesQuery, init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
1195
1196
|
/**
|
|
1196
1197
|
* Read metric values for accessible companies, grouped by company
|
|
1197
|
-
* 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.
|
|
1198
|
+
* 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` — case-insensitive exact match on either the full name or the `shortName`, so "MRR" and "MRR - Monthly Recurring Revenue" both work), 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.
|
|
1198
1199
|
* Parameters: body: MetricsSearchBody
|
|
1199
1200
|
* Returns: MetricsSearchResponse
|
|
1200
1201
|
*/
|
|
@@ -1208,7 +1209,7 @@ export interface MetricsNamespace {
|
|
|
1208
1209
|
compare(body: MetricsCompareBody, init?: RequestOptions): Promise<MetricsCompareResponse>
|
|
1209
1210
|
/**
|
|
1210
1211
|
* Aggregate metrics across portfolio companies
|
|
1211
|
-
* 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.
|
|
1212
|
+
* 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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so "no data" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then by the order of the requested `metricTypeIds`.
|
|
1212
1213
|
* Parameters: body: MetricsAggregateBody
|
|
1213
1214
|
* Returns: MetricsAggregateResponse
|
|
1214
1215
|
*/
|
|
@@ -1245,17 +1246,17 @@ export declare function createEmbedClient(options: CreateEmbedClientOptions): Em
|
|
|
1245
1246
|
|
|
1246
1247
|
export declare const routeManifest: {
|
|
1247
1248
|
companies: {
|
|
1248
|
-
getDashboards: { method: "POST"; path: "/companies/dashboards"; summary: "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call"; 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."; exampleCall: "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })"; responseType: "CompaniesGetDashboardsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1249
|
+
getDashboards: { method: "POST"; path: "/companies/dashboards"; summary: "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call"; 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` (case-insensitive exact match on full name or `shortName`) 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."; exampleCall: "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })"; responseType: "CompaniesGetDashboardsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1249
1250
|
getDashboard: { method: "GET"; path: "/companies/:id/dashboard"; summary: "Get full company dashboard for ONE company"; 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."; exampleCall: "client.companies.getDashboard(123, { currency: 'USD' })"; responseType: "CompaniesGetDashboardResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1250
|
-
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; 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
|
|
1251
|
+
getOne: { method: "GET"; path: "/companies/:id"; summary: "Get one company available to the SDK consumer"; 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 403 (not 404) both when the company does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /companies` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)"; exampleCall: "client.companies.getOne(123)"; responseType: "CompaniesGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1251
1252
|
getAll: { method: "GET"; path: "/companies"; summary: "List companies available to the SDK consumer"; 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."; exampleCall: "client.companies.getAll({ limit: 123 })"; responseType: "CompaniesGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1252
1253
|
}
|
|
1253
1254
|
companyGroups: {
|
|
1254
1255
|
getAll: { method: "GET"; path: "/company-groups"; summary: "List funds available to the SDK consumer"; 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."; exampleCall: "client.companyGroups.getAll({ limit: 123 })"; responseType: "CompanyGroupsGetAllResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1255
|
-
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one fund available to the SDK consumer"; 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
|
|
1256
|
+
getOne: { method: "GET"; path: "/company-groups/:id"; summary: "Get one fund available to the SDK consumer"; 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 403 (not 404) both when the fund does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /company-groups` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)"; exampleCall: "client.companyGroups.getOne(123)"; responseType: "CompanyGroupsGetOneResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1256
1257
|
}
|
|
1257
1258
|
positions: {
|
|
1258
|
-
getPortfolioSummary: { method: "GET"; path: "/positions/portfolio/summary"; summary: "Get portfolio summary with positions and key metrics per company"; 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
|
|
1259
|
+
getPortfolioSummary: { method: "GET"; path: "/positions/portfolio/summary"; summary: "Get portfolio summary with positions and key metrics per company"; 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` (case-insensitive exact match on full name or `shortName`). Designed for portfolio overview tables. Ordered by company id, then fund id."; exampleCall: "client.positions.getPortfolioSummary({ currency: 'USD' })"; responseType: "PositionsGetPortfolioSummaryResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1259
1260
|
getCompanyPositions: { method: "GET"; path: "/positions/companies/:id"; summary: "Get positions for one company"; 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."; exampleCall: "client.positions.getCompanyPositions(123, { currency: 'USD' })"; responseType: "PositionsGetCompanyPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1260
1261
|
getPortfolioPositions: { method: "GET"; path: "/positions/portfolio"; summary: "Get aggregated portfolio position totals"; 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`."; exampleCall: "client.positions.getPortfolioPositions({ currency: 'USD' })"; responseType: "PositionsGetPortfolioPositionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1261
1262
|
}
|
|
@@ -1266,9 +1267,9 @@ export declare const routeManifest: {
|
|
|
1266
1267
|
}
|
|
1267
1268
|
metrics: {
|
|
1268
1269
|
getTypes: { method: "GET"; path: "/metrics/types"; summary: "List metric types available to the SDK consumer"; 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."; exampleCall: "client.metrics.getTypes({ limit: 123 })"; responseType: "MetricsGetTypesResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1269
|
-
search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; 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."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1270
|
+
search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; 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` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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."; exampleCall: "client.metrics.search({})"; responseType: "MetricsSearchResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1270
1271
|
compare: { method: "POST"; path: "/metrics/compare"; summary: "Compare metrics across companies"; 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."; exampleCall: "client.metrics.compare({ metricTypeIds: [1,7] })"; responseType: "MetricsCompareResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1271
|
-
aggregate: { method: "POST"; path: "/metrics/aggregate"; summary: "Aggregate metrics across portfolio companies"; 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.
|
|
1272
|
+
aggregate: { method: "POST"; path: "/metrics/aggregate"; summary: "Aggregate metrics across portfolio companies"; 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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so \"no data\" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then by the order of the requested `metricTypeIds`."; exampleCall: "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })"; responseType: "MetricsAggregateResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1272
1273
|
}
|
|
1273
1274
|
companyReports: {
|
|
1274
1275
|
list: { method: "GET"; path: "/company-reports"; summary: "List published company reports accessible to the caller (metadata only)"; 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."; exampleCall: "client.companyReports.list({ limit: 123 })"; responseType: "CompanyReportsListResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@ const routeManifest = {
|
|
|
4
4
|
"method": "POST",
|
|
5
5
|
"path": "/companies/dashboards",
|
|
6
6
|
"summary": "PREFERRED tool for multi-company analysis — full dashboards for many companies in one call",
|
|
7
|
-
"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.",
|
|
7
|
+
"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` (case-insensitive exact match on full name or `shortName`) 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.",
|
|
8
8
|
"exampleCall": "client.companies.getDashboards({ companyIds: [123], currency: 'USD' })",
|
|
9
9
|
"responseType": "CompaniesGetDashboardsResponse",
|
|
10
10
|
"pathParams": [],
|
|
@@ -55,7 +55,7 @@ const routeManifest = {
|
|
|
55
55
|
"method": "GET",
|
|
56
56
|
"path": "/companies/:id",
|
|
57
57
|
"summary": "Get one company available to the SDK consumer",
|
|
58
|
-
"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
|
|
58
|
+
"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 403 (not 404) both when the company does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /companies` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
59
59
|
"exampleCall": "client.companies.getOne(123)",
|
|
60
60
|
"responseType": "CompaniesGetOneResponse",
|
|
61
61
|
"pathParams": [
|
|
@@ -149,7 +149,7 @@ const routeManifest = {
|
|
|
149
149
|
"method": "GET",
|
|
150
150
|
"path": "/company-groups/:id",
|
|
151
151
|
"summary": "Get one fund available to the SDK consumer",
|
|
152
|
-
"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
|
|
152
|
+
"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 403 (not 404) both when the fund does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /company-groups` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
153
153
|
"exampleCall": "client.companyGroups.getOne(123)",
|
|
154
154
|
"responseType": "CompanyGroupsGetOneResponse",
|
|
155
155
|
"pathParams": [
|
|
@@ -167,7 +167,7 @@ const routeManifest = {
|
|
|
167
167
|
"method": "GET",
|
|
168
168
|
"path": "/positions/portfolio/summary",
|
|
169
169
|
"summary": "Get portfolio summary with positions and key metrics per company",
|
|
170
|
-
"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
|
|
170
|
+
"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` (case-insensitive exact match on full name or `shortName`). Designed for portfolio overview tables. Ordered by company id, then fund id.",
|
|
171
171
|
"exampleCall": "client.positions.getPortfolioSummary({ currency: 'USD' })",
|
|
172
172
|
"responseType": "PositionsGetPortfolioSummaryResponse",
|
|
173
173
|
"pathParams": [],
|
|
@@ -212,7 +212,7 @@ const routeManifest = {
|
|
|
212
212
|
"name": "metricTypeNames",
|
|
213
213
|
"required": false,
|
|
214
214
|
"type": "string[]",
|
|
215
|
-
"description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway."
|
|
215
|
+
"description": "Metric type names to include in the latest metrics snapshot (case-insensitive exact match on display name or `shortName`). Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Names that match no accessible metric type are ignored."
|
|
216
216
|
}
|
|
217
217
|
]
|
|
218
218
|
},
|
|
@@ -482,7 +482,7 @@ const routeManifest = {
|
|
|
482
482
|
"method": "POST",
|
|
483
483
|
"path": "/metrics",
|
|
484
484
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
485
|
-
"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.",
|
|
485
|
+
"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` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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.",
|
|
486
486
|
"exampleCall": "client.metrics.search({})",
|
|
487
487
|
"responseType": "MetricsSearchResponse",
|
|
488
488
|
"pathParams": [],
|
|
@@ -502,7 +502,7 @@ const routeManifest = {
|
|
|
502
502
|
"method": "POST",
|
|
503
503
|
"path": "/metrics/aggregate",
|
|
504
504
|
"summary": "Aggregate metrics across portfolio companies",
|
|
505
|
-
"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.
|
|
505
|
+
"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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so \"no data\" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then by the order of the requested `metricTypeIds`.",
|
|
506
506
|
"exampleCall": "client.metrics.aggregate({ metricTypeIds: [1,7], aggregation: \"SUM\" })",
|
|
507
507
|
"responseType": "MetricsAggregateResponse",
|
|
508
508
|
"pathParams": [],
|
package/openapi.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"paths": {
|
|
4
4
|
"/api/v2/sdk/companies/dashboards": {
|
|
5
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). Dashboards come back in the order the `companyIds` were requested, so `limit`/`cursor` paging is stable.",
|
|
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` (case-insensitive exact match on full name or `shortName`) 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.",
|
|
7
7
|
"operationId": "companies.getDashboards",
|
|
8
8
|
"parameters": [],
|
|
9
9
|
"requestBody": {
|
|
@@ -29,6 +29,9 @@
|
|
|
29
29
|
},
|
|
30
30
|
"401": {
|
|
31
31
|
"description": "Missing or invalid SDK credentials"
|
|
32
|
+
},
|
|
33
|
+
"403": {
|
|
34
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
32
35
|
}
|
|
33
36
|
},
|
|
34
37
|
"security": [
|
|
@@ -43,6 +46,13 @@
|
|
|
43
46
|
"tags": [
|
|
44
47
|
"sdk-companies"
|
|
45
48
|
],
|
|
49
|
+
"x-api-key-scopes": [
|
|
50
|
+
"companies:read",
|
|
51
|
+
"transactions:read",
|
|
52
|
+
"metrics:read",
|
|
53
|
+
"positions:read",
|
|
54
|
+
"reports:read"
|
|
55
|
+
],
|
|
46
56
|
"x-sdk-audiences": [
|
|
47
57
|
"embed",
|
|
48
58
|
"client"
|
|
@@ -117,6 +127,9 @@
|
|
|
117
127
|
},
|
|
118
128
|
"401": {
|
|
119
129
|
"description": "Missing or invalid SDK credentials"
|
|
130
|
+
},
|
|
131
|
+
"403": {
|
|
132
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
120
133
|
}
|
|
121
134
|
},
|
|
122
135
|
"security": [
|
|
@@ -131,6 +144,13 @@
|
|
|
131
144
|
"tags": [
|
|
132
145
|
"sdk-companies"
|
|
133
146
|
],
|
|
147
|
+
"x-api-key-scopes": [
|
|
148
|
+
"companies:read",
|
|
149
|
+
"transactions:read",
|
|
150
|
+
"metrics:read",
|
|
151
|
+
"positions:read",
|
|
152
|
+
"reports:read"
|
|
153
|
+
],
|
|
134
154
|
"x-sdk-audiences": [
|
|
135
155
|
"embed",
|
|
136
156
|
"client"
|
|
@@ -141,7 +161,7 @@
|
|
|
141
161
|
},
|
|
142
162
|
"/api/v2/sdk/companies/{id}": {
|
|
143
163
|
"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
|
|
164
|
+
"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 403 (not 404) both when the company does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /companies` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
145
165
|
"operationId": "companies.getOne",
|
|
146
166
|
"parameters": [
|
|
147
167
|
{
|
|
@@ -167,6 +187,9 @@
|
|
|
167
187
|
},
|
|
168
188
|
"401": {
|
|
169
189
|
"description": "Missing or invalid SDK credentials"
|
|
190
|
+
},
|
|
191
|
+
"403": {
|
|
192
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
170
193
|
}
|
|
171
194
|
},
|
|
172
195
|
"security": [
|
|
@@ -181,6 +204,9 @@
|
|
|
181
204
|
"tags": [
|
|
182
205
|
"sdk-companies"
|
|
183
206
|
],
|
|
207
|
+
"x-api-key-scopes": [
|
|
208
|
+
"companies:read"
|
|
209
|
+
],
|
|
184
210
|
"x-sdk-audiences": [
|
|
185
211
|
"embed",
|
|
186
212
|
"client"
|
|
@@ -264,6 +290,9 @@
|
|
|
264
290
|
},
|
|
265
291
|
"401": {
|
|
266
292
|
"description": "Missing or invalid SDK credentials"
|
|
293
|
+
},
|
|
294
|
+
"403": {
|
|
295
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
267
296
|
}
|
|
268
297
|
},
|
|
269
298
|
"security": [
|
|
@@ -278,6 +307,9 @@
|
|
|
278
307
|
"tags": [
|
|
279
308
|
"sdk-companies"
|
|
280
309
|
],
|
|
310
|
+
"x-api-key-scopes": [
|
|
311
|
+
"companies:read"
|
|
312
|
+
],
|
|
281
313
|
"x-sdk-audiences": [
|
|
282
314
|
"embed",
|
|
283
315
|
"client"
|
|
@@ -349,6 +381,9 @@
|
|
|
349
381
|
},
|
|
350
382
|
"401": {
|
|
351
383
|
"description": "Missing or invalid SDK credentials"
|
|
384
|
+
},
|
|
385
|
+
"403": {
|
|
386
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
352
387
|
}
|
|
353
388
|
},
|
|
354
389
|
"security": [
|
|
@@ -363,6 +398,9 @@
|
|
|
363
398
|
"tags": [
|
|
364
399
|
"sdk-company-groups"
|
|
365
400
|
],
|
|
401
|
+
"x-api-key-scopes": [
|
|
402
|
+
"company-groups:read"
|
|
403
|
+
],
|
|
366
404
|
"x-sdk-audiences": [
|
|
367
405
|
"embed",
|
|
368
406
|
"client"
|
|
@@ -373,7 +411,7 @@
|
|
|
373
411
|
},
|
|
374
412
|
"/api/v2/sdk/company-groups/{id}": {
|
|
375
413
|
"get": {
|
|
376
|
-
"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
|
|
414
|
+
"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 403 (not 404) both when the fund does not exist and when it is outside the caller's access — existence is deliberately not disclosed. Once the request is authenticated and carries the required scope, a 403 on this route therefore means an unknown or inaccessible id; resolve ids via `GET /company-groups` first. (A missing API key scope also yields 403, with an \"Insufficient API key scopes\" message.)",
|
|
377
415
|
"operationId": "companyGroups.getOne",
|
|
378
416
|
"parameters": [
|
|
379
417
|
{
|
|
@@ -399,6 +437,9 @@
|
|
|
399
437
|
},
|
|
400
438
|
"401": {
|
|
401
439
|
"description": "Missing or invalid SDK credentials"
|
|
440
|
+
},
|
|
441
|
+
"403": {
|
|
442
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
402
443
|
}
|
|
403
444
|
},
|
|
404
445
|
"security": [
|
|
@@ -413,6 +454,9 @@
|
|
|
413
454
|
"tags": [
|
|
414
455
|
"sdk-company-groups"
|
|
415
456
|
],
|
|
457
|
+
"x-api-key-scopes": [
|
|
458
|
+
"company-groups:read"
|
|
459
|
+
],
|
|
416
460
|
"x-sdk-audiences": [
|
|
417
461
|
"embed",
|
|
418
462
|
"client"
|
|
@@ -423,7 +467,7 @@
|
|
|
423
467
|
},
|
|
424
468
|
"/api/v2/sdk/positions/portfolio/summary": {
|
|
425
469
|
"get": {
|
|
426
|
-
"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
|
|
470
|
+
"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` (case-insensitive exact match on full name or `shortName`). Designed for portfolio overview tables. Ordered by company id, then fund id.",
|
|
427
471
|
"operationId": "positions.getPortfolioSummary",
|
|
428
472
|
"parameters": [
|
|
429
473
|
{
|
|
@@ -492,7 +536,7 @@
|
|
|
492
536
|
"name": "metricTypeNames",
|
|
493
537
|
"required": false,
|
|
494
538
|
"in": "query",
|
|
495
|
-
"description": "Metric type names to include in the latest metrics snapshot. Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway.",
|
|
539
|
+
"description": "Metric type names to include in the latest metrics snapshot (case-insensitive exact match on display name or `shortName`). Defaults to MRR, Cash Balance, Headcount, Net Burn Rate, and Runway. Names that match no accessible metric type are ignored.",
|
|
496
540
|
"schema": {
|
|
497
541
|
"type": "array",
|
|
498
542
|
"items": {
|
|
@@ -514,6 +558,9 @@
|
|
|
514
558
|
},
|
|
515
559
|
"401": {
|
|
516
560
|
"description": "Missing or invalid SDK credentials"
|
|
561
|
+
},
|
|
562
|
+
"403": {
|
|
563
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
517
564
|
}
|
|
518
565
|
},
|
|
519
566
|
"security": [
|
|
@@ -528,6 +575,11 @@
|
|
|
528
575
|
"tags": [
|
|
529
576
|
"sdk-positions"
|
|
530
577
|
],
|
|
578
|
+
"x-api-key-scopes": [
|
|
579
|
+
"position-summaries:read",
|
|
580
|
+
"positions:read",
|
|
581
|
+
"metrics:read"
|
|
582
|
+
],
|
|
531
583
|
"x-sdk-audiences": [
|
|
532
584
|
"embed",
|
|
533
585
|
"client"
|
|
@@ -614,6 +666,9 @@
|
|
|
614
666
|
},
|
|
615
667
|
"401": {
|
|
616
668
|
"description": "Missing or invalid SDK credentials"
|
|
669
|
+
},
|
|
670
|
+
"403": {
|
|
671
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
617
672
|
}
|
|
618
673
|
},
|
|
619
674
|
"security": [
|
|
@@ -628,6 +683,9 @@
|
|
|
628
683
|
"tags": [
|
|
629
684
|
"sdk-positions"
|
|
630
685
|
],
|
|
686
|
+
"x-api-key-scopes": [
|
|
687
|
+
"positions:read"
|
|
688
|
+
],
|
|
631
689
|
"x-sdk-audiences": [
|
|
632
690
|
"embed",
|
|
633
691
|
"client"
|
|
@@ -697,6 +755,9 @@
|
|
|
697
755
|
},
|
|
698
756
|
"401": {
|
|
699
757
|
"description": "Missing or invalid SDK credentials"
|
|
758
|
+
},
|
|
759
|
+
"403": {
|
|
760
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
700
761
|
}
|
|
701
762
|
},
|
|
702
763
|
"security": [
|
|
@@ -711,6 +772,9 @@
|
|
|
711
772
|
"tags": [
|
|
712
773
|
"sdk-positions"
|
|
713
774
|
],
|
|
775
|
+
"x-api-key-scopes": [
|
|
776
|
+
"positions:read"
|
|
777
|
+
],
|
|
714
778
|
"x-sdk-audiences": [
|
|
715
779
|
"embed",
|
|
716
780
|
"client"
|
|
@@ -823,6 +887,9 @@
|
|
|
823
887
|
},
|
|
824
888
|
"401": {
|
|
825
889
|
"description": "Missing or invalid SDK credentials"
|
|
890
|
+
},
|
|
891
|
+
"403": {
|
|
892
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
826
893
|
}
|
|
827
894
|
},
|
|
828
895
|
"security": [
|
|
@@ -837,6 +904,9 @@
|
|
|
837
904
|
"tags": [
|
|
838
905
|
"sdk-transactions"
|
|
839
906
|
],
|
|
907
|
+
"x-api-key-scopes": [
|
|
908
|
+
"transactions:read"
|
|
909
|
+
],
|
|
840
910
|
"x-sdk-audiences": [
|
|
841
911
|
"embed",
|
|
842
912
|
"client"
|
|
@@ -948,6 +1018,9 @@
|
|
|
948
1018
|
},
|
|
949
1019
|
"401": {
|
|
950
1020
|
"description": "Missing or invalid SDK credentials"
|
|
1021
|
+
},
|
|
1022
|
+
"403": {
|
|
1023
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
951
1024
|
}
|
|
952
1025
|
},
|
|
953
1026
|
"security": [
|
|
@@ -962,6 +1035,9 @@
|
|
|
962
1035
|
"tags": [
|
|
963
1036
|
"sdk-transactions"
|
|
964
1037
|
],
|
|
1038
|
+
"x-api-key-scopes": [
|
|
1039
|
+
"transactions:read"
|
|
1040
|
+
],
|
|
965
1041
|
"x-sdk-audiences": [
|
|
966
1042
|
"embed",
|
|
967
1043
|
"client"
|
|
@@ -1076,6 +1152,9 @@
|
|
|
1076
1152
|
},
|
|
1077
1153
|
"401": {
|
|
1078
1154
|
"description": "Missing or invalid SDK credentials"
|
|
1155
|
+
},
|
|
1156
|
+
"403": {
|
|
1157
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1079
1158
|
}
|
|
1080
1159
|
},
|
|
1081
1160
|
"security": [
|
|
@@ -1090,6 +1169,9 @@
|
|
|
1090
1169
|
"tags": [
|
|
1091
1170
|
"sdk-transactions"
|
|
1092
1171
|
],
|
|
1172
|
+
"x-api-key-scopes": [
|
|
1173
|
+
"transactions:read"
|
|
1174
|
+
],
|
|
1093
1175
|
"x-sdk-audiences": [
|
|
1094
1176
|
"embed",
|
|
1095
1177
|
"client"
|
|
@@ -1137,6 +1219,9 @@
|
|
|
1137
1219
|
},
|
|
1138
1220
|
"401": {
|
|
1139
1221
|
"description": "Missing or invalid SDK credentials"
|
|
1222
|
+
},
|
|
1223
|
+
"403": {
|
|
1224
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1140
1225
|
}
|
|
1141
1226
|
},
|
|
1142
1227
|
"security": [
|
|
@@ -1151,6 +1236,9 @@
|
|
|
1151
1236
|
"tags": [
|
|
1152
1237
|
"sdk-metrics"
|
|
1153
1238
|
],
|
|
1239
|
+
"x-api-key-scopes": [
|
|
1240
|
+
"metric-types:read"
|
|
1241
|
+
],
|
|
1154
1242
|
"x-sdk-audiences": [
|
|
1155
1243
|
"embed",
|
|
1156
1244
|
"client"
|
|
@@ -1161,7 +1249,7 @@
|
|
|
1161
1249
|
},
|
|
1162
1250
|
"/api/v2/sdk/metrics": {
|
|
1163
1251
|
"post": {
|
|
1164
|
-
"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.",
|
|
1252
|
+
"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` — case-insensitive exact match on either the full name or the `shortName`, so \"MRR\" and \"MRR - Monthly Recurring Revenue\" both work), 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.",
|
|
1165
1253
|
"operationId": "metrics.search",
|
|
1166
1254
|
"parameters": [],
|
|
1167
1255
|
"requestBody": {
|
|
@@ -1187,6 +1275,9 @@
|
|
|
1187
1275
|
},
|
|
1188
1276
|
"401": {
|
|
1189
1277
|
"description": "Missing or invalid SDK credentials"
|
|
1278
|
+
},
|
|
1279
|
+
"403": {
|
|
1280
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1190
1281
|
}
|
|
1191
1282
|
},
|
|
1192
1283
|
"security": [
|
|
@@ -1201,6 +1292,9 @@
|
|
|
1201
1292
|
"tags": [
|
|
1202
1293
|
"sdk-metrics"
|
|
1203
1294
|
],
|
|
1295
|
+
"x-api-key-scopes": [
|
|
1296
|
+
"metrics:read"
|
|
1297
|
+
],
|
|
1204
1298
|
"x-sdk-audiences": [
|
|
1205
1299
|
"embed",
|
|
1206
1300
|
"client"
|
|
@@ -1237,6 +1331,9 @@
|
|
|
1237
1331
|
},
|
|
1238
1332
|
"401": {
|
|
1239
1333
|
"description": "Missing or invalid SDK credentials"
|
|
1334
|
+
},
|
|
1335
|
+
"403": {
|
|
1336
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1240
1337
|
}
|
|
1241
1338
|
},
|
|
1242
1339
|
"security": [
|
|
@@ -1251,6 +1348,9 @@
|
|
|
1251
1348
|
"tags": [
|
|
1252
1349
|
"sdk-metrics"
|
|
1253
1350
|
],
|
|
1351
|
+
"x-api-key-scopes": [
|
|
1352
|
+
"metrics:read"
|
|
1353
|
+
],
|
|
1254
1354
|
"x-sdk-audiences": [
|
|
1255
1355
|
"embed",
|
|
1256
1356
|
"client"
|
|
@@ -1261,7 +1361,7 @@
|
|
|
1261
1361
|
},
|
|
1262
1362
|
"/api/v2/sdk/metrics/aggregate": {
|
|
1263
1363
|
"post": {
|
|
1264
|
-
"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.
|
|
1364
|
+
"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. Every requested metric type the caller can access yields one entry (per fund when grouped) — with an empty `points` array when none of the selected companies has a value for it, so \"no data\" is explicit rather than a missing row. Ids that match no accessible metric type produce no entry. Select companies with `companyIds`, `companyNameSearch`, or `companyGroupIds`; when those select no company at all the response is an empty list. Ordered by fund id, then by the order of the requested `metricTypeIds`.",
|
|
1265
1365
|
"operationId": "metrics.aggregate",
|
|
1266
1366
|
"parameters": [],
|
|
1267
1367
|
"requestBody": {
|
|
@@ -1287,6 +1387,9 @@
|
|
|
1287
1387
|
},
|
|
1288
1388
|
"401": {
|
|
1289
1389
|
"description": "Missing or invalid SDK credentials"
|
|
1390
|
+
},
|
|
1391
|
+
"403": {
|
|
1392
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1290
1393
|
}
|
|
1291
1394
|
},
|
|
1292
1395
|
"security": [
|
|
@@ -1301,6 +1404,9 @@
|
|
|
1301
1404
|
"tags": [
|
|
1302
1405
|
"sdk-metrics"
|
|
1303
1406
|
],
|
|
1407
|
+
"x-api-key-scopes": [
|
|
1408
|
+
"metrics:read"
|
|
1409
|
+
],
|
|
1304
1410
|
"x-sdk-audiences": [
|
|
1305
1411
|
"embed",
|
|
1306
1412
|
"client"
|
|
@@ -1416,6 +1522,9 @@
|
|
|
1416
1522
|
},
|
|
1417
1523
|
"401": {
|
|
1418
1524
|
"description": "Missing or invalid SDK credentials"
|
|
1525
|
+
},
|
|
1526
|
+
"403": {
|
|
1527
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1419
1528
|
}
|
|
1420
1529
|
},
|
|
1421
1530
|
"security": [
|
|
@@ -1430,6 +1539,9 @@
|
|
|
1430
1539
|
"tags": [
|
|
1431
1540
|
"sdk-company-reports"
|
|
1432
1541
|
],
|
|
1542
|
+
"x-api-key-scopes": [
|
|
1543
|
+
"reports:read"
|
|
1544
|
+
],
|
|
1433
1545
|
"x-sdk-audiences": [
|
|
1434
1546
|
"embed",
|
|
1435
1547
|
"client"
|
|
@@ -1466,6 +1578,9 @@
|
|
|
1466
1578
|
},
|
|
1467
1579
|
"401": {
|
|
1468
1580
|
"description": "Missing or invalid SDK credentials"
|
|
1581
|
+
},
|
|
1582
|
+
"403": {
|
|
1583
|
+
"description": "Insufficient user permissions or API key scopes"
|
|
1469
1584
|
}
|
|
1470
1585
|
},
|
|
1471
1586
|
"security": [
|
|
@@ -1480,6 +1595,9 @@
|
|
|
1480
1595
|
"tags": [
|
|
1481
1596
|
"sdk-company-reports"
|
|
1482
1597
|
],
|
|
1598
|
+
"x-api-key-scopes": [
|
|
1599
|
+
"reports:read"
|
|
1600
|
+
],
|
|
1483
1601
|
"x-sdk-audiences": [
|
|
1484
1602
|
"embed",
|
|
1485
1603
|
"client"
|
|
@@ -1551,7 +1669,7 @@
|
|
|
1551
1669
|
]
|
|
1552
1670
|
},
|
|
1553
1671
|
"metricTypeNames": {
|
|
1554
|
-
"description": "Metric type names to include. Omit to include all metrics. Use metric type ids via `metricTypeIds` when ids are known.",
|
|
1672
|
+
"description": "Metric type names to include (case-insensitive exact match on display name or `shortName`). Omit to include all metrics. Use metric type ids via `metricTypeIds` when ids are known. Names that match no accessible metric type are ignored.",
|
|
1555
1673
|
"type": "array",
|
|
1556
1674
|
"items": {
|
|
1557
1675
|
"type": "string"
|
|
@@ -4963,7 +5081,7 @@
|
|
|
4963
5081
|
}
|
|
4964
5082
|
},
|
|
4965
5083
|
"metricTypeNames": {
|
|
4966
|
-
"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.",
|
|
5084
|
+
"description": "Resolve metric types by case-insensitive exact match on their display name OR `shortName` (so \"MRR\" matches \"MRR - Monthly Recurring Revenue\") and intersect with `metricTypeIds`. Lets the agent fetch by metric name (e.g. \"Revenue\") without first listing /metrics/types. Names that match no accessible metric type are ignored, so an empty result may mean a name did not resolve — verify names against /metrics/types.",
|
|
4967
5085
|
"type": "array",
|
|
4968
5086
|
"items": {
|
|
4969
5087
|
"type": "string"
|
|
@@ -5290,6 +5408,13 @@
|
|
|
5290
5408
|
"type": "number"
|
|
5291
5409
|
}
|
|
5292
5410
|
},
|
|
5411
|
+
"companyNameSearch": {
|
|
5412
|
+
"description": "Case-insensitive substring match on company display name. Pass an array to select 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`. When the combined company filters select no company at all, the response is an empty list — nothing to aggregate over.",
|
|
5413
|
+
"type": "array",
|
|
5414
|
+
"items": {
|
|
5415
|
+
"type": "string"
|
|
5416
|
+
}
|
|
5417
|
+
},
|
|
5293
5418
|
"companyGroupIds": {
|
|
5294
5419
|
"description": "Restrict to companies that belong to any of these company groups.",
|
|
5295
5420
|
"type": "array",
|
|
@@ -5409,7 +5534,7 @@
|
|
|
5409
5534
|
]
|
|
5410
5535
|
},
|
|
5411
5536
|
"points": {
|
|
5412
|
-
"description": "Aggregated data points ordered by date ascending.",
|
|
5537
|
+
"description": "Aggregated data points ordered by date ascending. Empty when none of the selected companies has a value for this metric type — the entry is still returned so \"no data\" is explicit.",
|
|
5413
5538
|
"type": "array",
|
|
5414
5539
|
"items": {
|
|
5415
5540
|
"$ref": "#/components/schemas/SdkAggregatedPointDto"
|