@rundit-sdk/embed 0.3.5-rc.17 → 0.3.6-rc.19
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 -2
- package/README.md +2 -2
- package/ai-manifest.json +8 -2
- package/dist/index.d.ts +15 -5
- package/dist/index.js +8 -2
- package/openapi.json +629 -2
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -87,10 +87,10 @@ console.log(routeManifest)
|
|
|
87
87
|
|
|
88
88
|
## metrics
|
|
89
89
|
|
|
90
|
-
- metrics.getTypes:
|
|
90
|
+
- metrics.getTypes: Search metric types available to the SDK consumer
|
|
91
91
|
- Call: `client.metrics.getTypes({ limit: 123 })`
|
|
92
92
|
- Returns: `MetricsGetTypesResponse`
|
|
93
|
-
- Params: query: limit? (number), cursor? (string), nameSearch? (string[])
|
|
93
|
+
- Params: query: limit? (number), cursor? (string), origin? ("Predefined" | "UserDefined"), nameSearch? (string[])
|
|
94
94
|
- metrics.search: Read metric values for accessible companies, grouped by company
|
|
95
95
|
- Call: `client.metrics.search({})`
|
|
96
96
|
- Returns: `MetricsSearchResponse`
|
package/README.md
CHANGED
|
@@ -162,12 +162,12 @@ Get transactions for multiple companies
|
|
|
162
162
|
|
|
163
163
|
### `metrics.getTypes`
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
Search metric types available to the SDK consumer
|
|
166
166
|
|
|
167
167
|
- Call: `client.metrics.getTypes({ limit: 123 })`
|
|
168
168
|
- HTTP: `GET /metrics/types`
|
|
169
169
|
- Returns: `MetricsGetTypesResponse`
|
|
170
|
-
- Params: query: limit? (number), cursor? (string), nameSearch? (string[])
|
|
170
|
+
- Params: query: limit? (number), cursor? (string), origin? ("Predefined" | "UserDefined"), nameSearch? (string[])
|
|
171
171
|
|
|
172
172
|
### `metrics.search`
|
|
173
173
|
|
package/ai-manifest.json
CHANGED
|
@@ -549,7 +549,7 @@
|
|
|
549
549
|
"metrics": [
|
|
550
550
|
{
|
|
551
551
|
"operation": "getTypes",
|
|
552
|
-
"summary": "
|
|
552
|
+
"summary": "Search metric types available to the SDK consumer",
|
|
553
553
|
"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. Filter with `nameSearch` (case-insensitive substring on name or `shortName`, OR across an array) to find a few types without paging the whole catalogue — e.g. `nameSearch=[\"mrr\",\"burn\"]`. Ordered by metric type id ascending.",
|
|
554
554
|
"method": "GET",
|
|
555
555
|
"path": "/metrics/types",
|
|
@@ -569,6 +569,12 @@
|
|
|
569
569
|
"type": "string",
|
|
570
570
|
"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."
|
|
571
571
|
},
|
|
572
|
+
{
|
|
573
|
+
"name": "origin",
|
|
574
|
+
"required": false,
|
|
575
|
+
"type": "\"Predefined\" | \"UserDefined\"",
|
|
576
|
+
"description": null
|
|
577
|
+
},
|
|
572
578
|
{
|
|
573
579
|
"name": "nameSearch",
|
|
574
580
|
"required": false,
|
|
@@ -580,7 +586,7 @@
|
|
|
580
586
|
{
|
|
581
587
|
"operation": "search",
|
|
582
588
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
583
|
-
"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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
589
|
+
"description": "Row existence does not imply a current investor request: removing template targeting preserves reported data. Use metricTemplates.get and its company/group targeting to inspect request state; entries outside full targeting visibility are omitted, so absence from a restricted template response is not proof of no request. 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
584
590
|
"method": "POST",
|
|
585
591
|
"path": "/metrics",
|
|
586
592
|
"exampleCall": "client.metrics.search({})",
|
package/dist/index.d.ts
CHANGED
|
@@ -162,10 +162,17 @@ export interface SdkMetricPointDto {
|
|
|
162
162
|
aggregated?: boolean
|
|
163
163
|
}
|
|
164
164
|
|
|
165
|
+
export interface SdkMetricSubRowDto {
|
|
166
|
+
id: number
|
|
167
|
+
flavor: "forecast" | "budget"
|
|
168
|
+
points: SdkMetricPointDto[]
|
|
169
|
+
}
|
|
170
|
+
|
|
165
171
|
export interface SdkCompanyMetricDto {
|
|
166
172
|
id: number
|
|
167
173
|
metricType: SdkMetricTypeSummaryDto
|
|
168
174
|
points: SdkMetricPointDto[]
|
|
175
|
+
subRows?: SdkMetricSubRowDto[]
|
|
169
176
|
}
|
|
170
177
|
|
|
171
178
|
export interface SdkCompanyDashboardMetricsDto {
|
|
@@ -589,6 +596,7 @@ export interface SdkMetricTypeDto {
|
|
|
589
596
|
unit?: SdkMetricUnitDto
|
|
590
597
|
optionConfig?: SdkMetricTypeOptionConfigDto
|
|
591
598
|
rangeConfig?: SdkMetricTypeRangeConfigDto
|
|
599
|
+
summaryAggregationMethods: ("SUM" | "AVG" | "MEDIAN" | "COUNT_POSITIVES" | "AVG_POSITIVES_PERCENTAGE")[]
|
|
592
600
|
description?: string | null
|
|
593
601
|
origin?: "Predefined" | "UserDefined"
|
|
594
602
|
aggMethod: "SUM" | "LAST_AVAILABLE" | "AVG" | "NONE"
|
|
@@ -613,6 +621,7 @@ export interface SdkCompanyMetricsListResponseDto {
|
|
|
613
621
|
export interface MetricSearchDto {
|
|
614
622
|
limit?: number
|
|
615
623
|
cursor?: string
|
|
624
|
+
includePoints?: boolean
|
|
616
625
|
companyIds?: number[]
|
|
617
626
|
companyNameSearch?: string[]
|
|
618
627
|
companyGroupIds?: number[]
|
|
@@ -1104,6 +1113,7 @@ export interface MetricsGetTypesQuery {
|
|
|
1104
1113
|
* 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.
|
|
1105
1114
|
*/
|
|
1106
1115
|
cursor?: string
|
|
1116
|
+
origin?: "Predefined" | "UserDefined"
|
|
1107
1117
|
/**
|
|
1108
1118
|
* Case-insensitive substring match on metric type name or `shortName`. Pass an array to look up several types in one call — a type matches if ANY listed substring occurs (OR semantics). Use it to find ids or exact names without paging the whole catalogue.
|
|
1109
1119
|
*/
|
|
@@ -1247,15 +1257,15 @@ export interface TransactionsNamespace {
|
|
|
1247
1257
|
|
|
1248
1258
|
export interface MetricsNamespace {
|
|
1249
1259
|
/**
|
|
1250
|
-
*
|
|
1260
|
+
* Search metric types available to the SDK consumer
|
|
1251
1261
|
* 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. Filter with `nameSearch` (case-insensitive substring on name or `shortName`, OR across an array) to find a few types without paging the whole catalogue — e.g. `nameSearch=["mrr","burn"]`. Ordered by metric type id ascending.
|
|
1252
|
-
* Parameters: query: limit? (number), cursor? (string), nameSearch? (string[])
|
|
1262
|
+
* Parameters: query: limit? (number), cursor? (string), origin? ("Predefined" | "UserDefined"), nameSearch? (string[])
|
|
1253
1263
|
* Returns: MetricsGetTypesResponse
|
|
1254
1264
|
*/
|
|
1255
1265
|
getTypes(query?: MetricsGetTypesQuery, init?: RequestOptions): Promise<MetricsGetTypesResponse>
|
|
1256
1266
|
/**
|
|
1257
1267
|
* Read metric values for accessible companies, grouped by company
|
|
1258
|
-
* 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.
|
|
1268
|
+
* Row existence does not imply a current investor request: removing template targeting preserves reported data. Use metricTemplates.get and its company/group targeting to inspect request state; entries outside full targeting visibility are omitted, so absence from a restricted template response is not proof of no request. 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.
|
|
1259
1269
|
* Parameters: body: MetricsSearchBody
|
|
1260
1270
|
* Returns: MetricsSearchResponse
|
|
1261
1271
|
*/
|
|
@@ -1326,8 +1336,8 @@ export declare const routeManifest: {
|
|
|
1326
1336
|
getTransactions: { method: "GET"; path: "/transactions"; summary: "Get transactions for multiple companies"; 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."; exampleCall: "client.transactions.getTransactions({ limit: 123 })"; responseType: "TransactionsGetTransactionsResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1327
1337
|
}
|
|
1328
1338
|
metrics: {
|
|
1329
|
-
getTypes: { method: "GET"; path: "/metrics/types"; summary: "
|
|
1330
|
-
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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. 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 }[] }
|
|
1339
|
+
getTypes: { method: "GET"; path: "/metrics/types"; summary: "Search 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. Filter with `nameSearch` (case-insensitive substring on name or `shortName`, OR across an array) to find a few types without paging the whole catalogue — e.g. `nameSearch=[\"mrr\",\"burn\"]`. 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 }[] }
|
|
1340
|
+
search: { method: "POST"; path: "/metrics"; summary: "Read metric values for accessible companies, grouped by company"; description: "Row existence does not imply a current investor request: removing template targeting preserves reported data. Use metricTemplates.get and its company/group targeting to inspect request state; entries outside full targeting visibility are omitted, so absence from a restricted template response is not proof of no request. 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. 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 }[] }
|
|
1331
1341
|
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. Select metric types with `metricTypeIds` and/or `metricTypeNames` (case-insensitive exact match on name or `shortName`, e.g. \"MRR\"); several metrics are compared in a single round trip, one entry per metric type in `metricTypeIds` order; name-only selections follow catalogue order. 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({})"; responseType: "MetricsCompareResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1332
1342
|
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. Select metric types with `metricTypeIds` and/or `metricTypeNames` (case-insensitive exact match on name or `shortName`, e.g. \"MRR\"). 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 in the order the metric types were requested (`metricTypeIds` order; name-resolved types follow the catalogue order)."; exampleCall: "client.metrics.aggregate({ aggregation: \"SUM\" })"; responseType: "MetricsAggregateResponse"; pathParams: { name: string; type: string; description: string | null }[]; queryParams: { name: string; type: string; required: boolean; description: string | null }[] }
|
|
1333
1343
|
}
|
package/dist/index.js
CHANGED
|
@@ -518,7 +518,7 @@ const routeManifest = {
|
|
|
518
518
|
"getTypes": {
|
|
519
519
|
"method": "GET",
|
|
520
520
|
"path": "/metrics/types",
|
|
521
|
-
"summary": "
|
|
521
|
+
"summary": "Search metric types available to the SDK consumer",
|
|
522
522
|
"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. Filter with `nameSearch` (case-insensitive substring on name or `shortName`, OR across an array) to find a few types without paging the whole catalogue — e.g. `nameSearch=[\"mrr\",\"burn\"]`. Ordered by metric type id ascending.",
|
|
523
523
|
"exampleCall": "client.metrics.getTypes({ limit: 123 })",
|
|
524
524
|
"responseType": "MetricsGetTypesResponse",
|
|
@@ -536,6 +536,12 @@ const routeManifest = {
|
|
|
536
536
|
"type": "string",
|
|
537
537
|
"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."
|
|
538
538
|
},
|
|
539
|
+
{
|
|
540
|
+
"name": "origin",
|
|
541
|
+
"required": false,
|
|
542
|
+
"type": "\"Predefined\" | \"UserDefined\"",
|
|
543
|
+
"description": null
|
|
544
|
+
},
|
|
539
545
|
{
|
|
540
546
|
"name": "nameSearch",
|
|
541
547
|
"required": false,
|
|
@@ -548,7 +554,7 @@ const routeManifest = {
|
|
|
548
554
|
"method": "POST",
|
|
549
555
|
"path": "/metrics",
|
|
550
556
|
"summary": "Read metric values for accessible companies, grouped by company",
|
|
551
|
-
"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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
557
|
+
"description": "Row existence does not imply a current investor request: removing template targeting preserves reported data. Use metricTemplates.get and its company/group targeting to inspect request state; entries outside full targeting visibility are omitted, so absence from a restricted template response is not proof of no request. 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
552
558
|
"exampleCall": "client.metrics.search({})",
|
|
553
559
|
"responseType": "MetricsSearchResponse",
|
|
554
560
|
"pathParams": [],
|
package/openapi.json
CHANGED
|
@@ -1329,6 +1329,18 @@
|
|
|
1329
1329
|
"type": "string"
|
|
1330
1330
|
}
|
|
1331
1331
|
},
|
|
1332
|
+
{
|
|
1333
|
+
"name": "origin",
|
|
1334
|
+
"required": false,
|
|
1335
|
+
"in": "query",
|
|
1336
|
+
"schema": {
|
|
1337
|
+
"type": "string",
|
|
1338
|
+
"enum": [
|
|
1339
|
+
"Predefined",
|
|
1340
|
+
"UserDefined"
|
|
1341
|
+
]
|
|
1342
|
+
}
|
|
1343
|
+
},
|
|
1332
1344
|
{
|
|
1333
1345
|
"name": "nameSearch",
|
|
1334
1346
|
"required": false,
|
|
@@ -1368,7 +1380,7 @@
|
|
|
1368
1380
|
"sdk-client-api-key": []
|
|
1369
1381
|
}
|
|
1370
1382
|
],
|
|
1371
|
-
"summary": "
|
|
1383
|
+
"summary": "Search metric types available to the SDK consumer",
|
|
1372
1384
|
"tags": [
|
|
1373
1385
|
"sdk-metrics"
|
|
1374
1386
|
],
|
|
@@ -1385,7 +1397,7 @@
|
|
|
1385
1397
|
},
|
|
1386
1398
|
"/api/v2/sdk/metrics": {
|
|
1387
1399
|
"post": {
|
|
1388
|
-
"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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
1400
|
+
"description": "Row existence does not imply a current investor request: removing template targeting preserves reported data. Use metricTemplates.get and its company/group targeting to inspect request state; entries outside full targeting visibility are omitted, so absence from a restricted template response is not proof of no request. 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`. Each entry embeds a metric type *summary* (id, name, shortName, valueType, unit, plus option/range config when relevant); the full definition lives on /metrics/types. 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. Use `pointLimit` to keep only the most recent N points per metric (`pointLimit: 1` = latest dated point; set `to` to today to exclude future values) — without it every historical point is returned, which can be very large across a portfolio. Entries are ordered by company id ascending — one entry per company, so `limit` pages whole companies, never partial metric lists.",
|
|
1389
1401
|
"operationId": "metrics.search",
|
|
1390
1402
|
"parameters": [],
|
|
1391
1403
|
"requestBody": {
|
|
@@ -2633,6 +2645,33 @@
|
|
|
2633
2645
|
"optionValue"
|
|
2634
2646
|
]
|
|
2635
2647
|
},
|
|
2648
|
+
"SdkMetricSubRowDto": {
|
|
2649
|
+
"type": "object",
|
|
2650
|
+
"properties": {
|
|
2651
|
+
"id": {
|
|
2652
|
+
"type": "number",
|
|
2653
|
+
"description": "Writable metric row id. Use with metrics.writePoints or metrics.deletePoints."
|
|
2654
|
+
},
|
|
2655
|
+
"flavor": {
|
|
2656
|
+
"type": "string",
|
|
2657
|
+
"enum": [
|
|
2658
|
+
"forecast",
|
|
2659
|
+
"budget"
|
|
2660
|
+
]
|
|
2661
|
+
},
|
|
2662
|
+
"points": {
|
|
2663
|
+
"type": "array",
|
|
2664
|
+
"items": {
|
|
2665
|
+
"$ref": "#/components/schemas/SdkMetricPointDto"
|
|
2666
|
+
}
|
|
2667
|
+
}
|
|
2668
|
+
},
|
|
2669
|
+
"required": [
|
|
2670
|
+
"id",
|
|
2671
|
+
"flavor",
|
|
2672
|
+
"points"
|
|
2673
|
+
]
|
|
2674
|
+
},
|
|
2636
2675
|
"SdkCompanyMetricDto": {
|
|
2637
2676
|
"type": "object",
|
|
2638
2677
|
"properties": {
|
|
@@ -2654,6 +2693,13 @@
|
|
|
2654
2693
|
"items": {
|
|
2655
2694
|
"$ref": "#/components/schemas/SdkMetricPointDto"
|
|
2656
2695
|
}
|
|
2696
|
+
},
|
|
2697
|
+
"subRows": {
|
|
2698
|
+
"description": "Existing forecast/budget rows with writable ids and filtered points, including empty rows. Actual values remain in points.",
|
|
2699
|
+
"type": "array",
|
|
2700
|
+
"items": {
|
|
2701
|
+
"$ref": "#/components/schemas/SdkMetricSubRowDto"
|
|
2702
|
+
}
|
|
2657
2703
|
}
|
|
2658
2704
|
},
|
|
2659
2705
|
"required": [
|
|
@@ -5247,6 +5293,20 @@
|
|
|
5247
5293
|
}
|
|
5248
5294
|
]
|
|
5249
5295
|
},
|
|
5296
|
+
"summaryAggregationMethods": {
|
|
5297
|
+
"type": "array",
|
|
5298
|
+
"description": "Enabled aggregations across portfolio companies.",
|
|
5299
|
+
"items": {
|
|
5300
|
+
"type": "string",
|
|
5301
|
+
"enum": [
|
|
5302
|
+
"SUM",
|
|
5303
|
+
"AVG",
|
|
5304
|
+
"MEDIAN",
|
|
5305
|
+
"COUNT_POSITIVES",
|
|
5306
|
+
"AVG_POSITIVES_PERCENTAGE"
|
|
5307
|
+
]
|
|
5308
|
+
}
|
|
5309
|
+
},
|
|
5250
5310
|
"description": {
|
|
5251
5311
|
"type": "string",
|
|
5252
5312
|
"description": "Free-form description of what the metric represents.",
|
|
@@ -5274,6 +5334,7 @@
|
|
|
5274
5334
|
"required": [
|
|
5275
5335
|
"id",
|
|
5276
5336
|
"name",
|
|
5337
|
+
"summaryAggregationMethods",
|
|
5277
5338
|
"aggMethod"
|
|
5278
5339
|
]
|
|
5279
5340
|
},
|
|
@@ -5462,6 +5523,41 @@
|
|
|
5462
5523
|
"points"
|
|
5463
5524
|
]
|
|
5464
5525
|
},
|
|
5526
|
+
"SdkMetricPointDeleteDto": {
|
|
5527
|
+
"type": "object",
|
|
5528
|
+
"properties": {
|
|
5529
|
+
"date": {
|
|
5530
|
+
"type": "string",
|
|
5531
|
+
"description": "Reporting period date (YYYY-MM-DD), on the first day of the month."
|
|
5532
|
+
},
|
|
5533
|
+
"timeframe": {
|
|
5534
|
+
"type": "string",
|
|
5535
|
+
"enum": [
|
|
5536
|
+
"Month",
|
|
5537
|
+
"Quarter",
|
|
5538
|
+
"Year"
|
|
5539
|
+
]
|
|
5540
|
+
}
|
|
5541
|
+
},
|
|
5542
|
+
"required": [
|
|
5543
|
+
"date",
|
|
5544
|
+
"timeframe"
|
|
5545
|
+
]
|
|
5546
|
+
},
|
|
5547
|
+
"SdkMetricPointsDeleteRequestDto": {
|
|
5548
|
+
"type": "object",
|
|
5549
|
+
"properties": {
|
|
5550
|
+
"points": {
|
|
5551
|
+
"type": "array",
|
|
5552
|
+
"items": {
|
|
5553
|
+
"$ref": "#/components/schemas/SdkMetricPointDeleteDto"
|
|
5554
|
+
}
|
|
5555
|
+
}
|
|
5556
|
+
},
|
|
5557
|
+
"required": [
|
|
5558
|
+
"points"
|
|
5559
|
+
]
|
|
5560
|
+
},
|
|
5465
5561
|
"MetricSearchDto": {
|
|
5466
5562
|
"type": "object",
|
|
5467
5563
|
"properties": {
|
|
@@ -5475,6 +5571,11 @@
|
|
|
5475
5571
|
"type": "string",
|
|
5476
5572
|
"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."
|
|
5477
5573
|
},
|
|
5574
|
+
"includePoints": {
|
|
5575
|
+
"type": "boolean",
|
|
5576
|
+
"default": true,
|
|
5577
|
+
"description": "Set false to enumerate metric ids, types, units and forecast/budget rows without loading or computing point histories. Returns empty points arrays. Date/timeframe/pointLimit filters only apply when points are included."
|
|
5578
|
+
},
|
|
5478
5579
|
"companyIds": {
|
|
5479
5580
|
"description": "Restrict results to these companies. Defaults to all companies the caller can access.",
|
|
5480
5581
|
"type": "array",
|
|
@@ -6013,6 +6114,532 @@
|
|
|
6013
6114
|
"meta"
|
|
6014
6115
|
]
|
|
6015
6116
|
},
|
|
6117
|
+
"SdkCreateMetricOptionDto": {
|
|
6118
|
+
"type": "object",
|
|
6119
|
+
"properties": {
|
|
6120
|
+
"value": {
|
|
6121
|
+
"type": "string"
|
|
6122
|
+
},
|
|
6123
|
+
"isPositive": {
|
|
6124
|
+
"type": "boolean"
|
|
6125
|
+
}
|
|
6126
|
+
},
|
|
6127
|
+
"required": [
|
|
6128
|
+
"value",
|
|
6129
|
+
"isPositive"
|
|
6130
|
+
]
|
|
6131
|
+
},
|
|
6132
|
+
"SdkCreateMetricOptionsDto": {
|
|
6133
|
+
"type": "object",
|
|
6134
|
+
"properties": {
|
|
6135
|
+
"options": {
|
|
6136
|
+
"minItems": 1,
|
|
6137
|
+
"maxItems": 100,
|
|
6138
|
+
"type": "array",
|
|
6139
|
+
"items": {
|
|
6140
|
+
"$ref": "#/components/schemas/SdkCreateMetricOptionDto"
|
|
6141
|
+
}
|
|
6142
|
+
}
|
|
6143
|
+
},
|
|
6144
|
+
"required": [
|
|
6145
|
+
"options"
|
|
6146
|
+
]
|
|
6147
|
+
},
|
|
6148
|
+
"SdkCreateMetricRangeDto": {
|
|
6149
|
+
"type": "object",
|
|
6150
|
+
"properties": {
|
|
6151
|
+
"min": {
|
|
6152
|
+
"type": "number"
|
|
6153
|
+
},
|
|
6154
|
+
"max": {
|
|
6155
|
+
"type": "number"
|
|
6156
|
+
},
|
|
6157
|
+
"step": {
|
|
6158
|
+
"type": "number"
|
|
6159
|
+
}
|
|
6160
|
+
},
|
|
6161
|
+
"required": [
|
|
6162
|
+
"min",
|
|
6163
|
+
"max",
|
|
6164
|
+
"step"
|
|
6165
|
+
]
|
|
6166
|
+
},
|
|
6167
|
+
"SdkCreateMetricTypeDto": {
|
|
6168
|
+
"type": "object",
|
|
6169
|
+
"properties": {
|
|
6170
|
+
"name": {
|
|
6171
|
+
"type": "string",
|
|
6172
|
+
"description": "Name of the custom metric definition. Does not create company rows."
|
|
6173
|
+
},
|
|
6174
|
+
"shortName": {
|
|
6175
|
+
"type": "string"
|
|
6176
|
+
},
|
|
6177
|
+
"description": {
|
|
6178
|
+
"type": "string"
|
|
6179
|
+
},
|
|
6180
|
+
"valueType": {
|
|
6181
|
+
"type": "string",
|
|
6182
|
+
"enum": [
|
|
6183
|
+
"numeric",
|
|
6184
|
+
"option"
|
|
6185
|
+
]
|
|
6186
|
+
},
|
|
6187
|
+
"unit": {
|
|
6188
|
+
"type": "string",
|
|
6189
|
+
"enum": [
|
|
6190
|
+
"Percentage",
|
|
6191
|
+
"Currency",
|
|
6192
|
+
"Number",
|
|
6193
|
+
"Second",
|
|
6194
|
+
"Minute",
|
|
6195
|
+
"Hour",
|
|
6196
|
+
"Day",
|
|
6197
|
+
"Week",
|
|
6198
|
+
"Month",
|
|
6199
|
+
"Quarter",
|
|
6200
|
+
"Year"
|
|
6201
|
+
],
|
|
6202
|
+
"nullable": true,
|
|
6203
|
+
"description": "Required for numeric metrics; omit for option metrics."
|
|
6204
|
+
},
|
|
6205
|
+
"aggMethod": {
|
|
6206
|
+
"type": "string",
|
|
6207
|
+
"enum": [
|
|
6208
|
+
"SUM",
|
|
6209
|
+
"LAST_AVAILABLE",
|
|
6210
|
+
"AVG",
|
|
6211
|
+
"NONE"
|
|
6212
|
+
],
|
|
6213
|
+
"description": "Across-period aggregation. Option and ranged metrics require NONE."
|
|
6214
|
+
},
|
|
6215
|
+
"summaryAggregationMethods": {
|
|
6216
|
+
"type": "array",
|
|
6217
|
+
"items": {
|
|
6218
|
+
"type": "string",
|
|
6219
|
+
"enum": [
|
|
6220
|
+
"SUM",
|
|
6221
|
+
"AVG",
|
|
6222
|
+
"MEDIAN",
|
|
6223
|
+
"COUNT_POSITIVES",
|
|
6224
|
+
"AVG_POSITIVES_PERCENTAGE"
|
|
6225
|
+
]
|
|
6226
|
+
}
|
|
6227
|
+
},
|
|
6228
|
+
"optionConfig": {
|
|
6229
|
+
"$ref": "#/components/schemas/SdkCreateMetricOptionsDto"
|
|
6230
|
+
},
|
|
6231
|
+
"rangeConfig": {
|
|
6232
|
+
"$ref": "#/components/schemas/SdkCreateMetricRangeDto"
|
|
6233
|
+
}
|
|
6234
|
+
},
|
|
6235
|
+
"required": [
|
|
6236
|
+
"name",
|
|
6237
|
+
"valueType",
|
|
6238
|
+
"aggMethod",
|
|
6239
|
+
"summaryAggregationMethods"
|
|
6240
|
+
]
|
|
6241
|
+
},
|
|
6242
|
+
"SdkMetricImportItemDto": {
|
|
6243
|
+
"type": "object",
|
|
6244
|
+
"properties": {
|
|
6245
|
+
"metricTypeId": {
|
|
6246
|
+
"type": "number",
|
|
6247
|
+
"description": "Use exactly one of metricTypeId, metricTypeName or createType."
|
|
6248
|
+
},
|
|
6249
|
+
"metricTypeName": {
|
|
6250
|
+
"type": "string",
|
|
6251
|
+
"description": "Use exactly one of metricTypeId, metricTypeName or createType. Exact case-insensitive name or shortName. Unknown or ambiguous names fail; no fuzzy writes."
|
|
6252
|
+
},
|
|
6253
|
+
"createType": {
|
|
6254
|
+
"description": "Use exactly one of metricTypeId, metricTypeName or createType. Create only if no accessible type matches the name and provisionMissing is true. Retries reuse a VC-owned full-name match with identical configuration; mismatches return a conflict.",
|
|
6255
|
+
"allOf": [
|
|
6256
|
+
{
|
|
6257
|
+
"$ref": "#/components/schemas/SdkCreateMetricTypeDto"
|
|
6258
|
+
}
|
|
6259
|
+
]
|
|
6260
|
+
},
|
|
6261
|
+
"flavor": {
|
|
6262
|
+
"type": "string",
|
|
6263
|
+
"enum": [
|
|
6264
|
+
"actual",
|
|
6265
|
+
"forecast",
|
|
6266
|
+
"budget"
|
|
6267
|
+
],
|
|
6268
|
+
"default": "actual"
|
|
6269
|
+
},
|
|
6270
|
+
"points": {
|
|
6271
|
+
"minItems": 1,
|
|
6272
|
+
"maxItems": 250,
|
|
6273
|
+
"type": "array",
|
|
6274
|
+
"items": {
|
|
6275
|
+
"$ref": "#/components/schemas/SdkMetricPointWriteDto"
|
|
6276
|
+
}
|
|
6277
|
+
}
|
|
6278
|
+
},
|
|
6279
|
+
"description": "Supply exactly one of metricTypeId, metricTypeName or createType. Persisted type IDs identify distinct targets even when names match.",
|
|
6280
|
+
"required": [
|
|
6281
|
+
"points"
|
|
6282
|
+
]
|
|
6283
|
+
},
|
|
6284
|
+
"SdkCompanyMetricImportDto": {
|
|
6285
|
+
"type": "object",
|
|
6286
|
+
"properties": {
|
|
6287
|
+
"companyId": {
|
|
6288
|
+
"type": "number",
|
|
6289
|
+
"description": "One accessible portfolio company. New template targeting adds this company only; existing targeting is never replaced."
|
|
6290
|
+
},
|
|
6291
|
+
"currency": {
|
|
6292
|
+
"type": "string",
|
|
6293
|
+
"description": "Source currency, e.g. USD. Must equal company native currency. No implicit FX conversion on writes."
|
|
6294
|
+
},
|
|
6295
|
+
"items": {
|
|
6296
|
+
"minItems": 1,
|
|
6297
|
+
"maxItems": 50,
|
|
6298
|
+
"description": "Each item must supply exactly one of metricTypeId, metricTypeName or createType, plus flavor and points.",
|
|
6299
|
+
"type": "array",
|
|
6300
|
+
"items": {
|
|
6301
|
+
"$ref": "#/components/schemas/SdkMetricImportItemDto"
|
|
6302
|
+
}
|
|
6303
|
+
}
|
|
6304
|
+
},
|
|
6305
|
+
"required": [
|
|
6306
|
+
"companyId",
|
|
6307
|
+
"currency",
|
|
6308
|
+
"items"
|
|
6309
|
+
]
|
|
6310
|
+
},
|
|
6311
|
+
"SdkMetricImportDto": {
|
|
6312
|
+
"type": "object",
|
|
6313
|
+
"properties": {
|
|
6314
|
+
"provisionMissing": {
|
|
6315
|
+
"type": "boolean",
|
|
6316
|
+
"default": true,
|
|
6317
|
+
"description": "Allow creation of missing definitions and template-requested rows. Set false for existing-row-only writes: missing types or flavors fail without provisioning. Creating definitions still requires createType explicitly. Default true preserves the provisioning workflow."
|
|
6318
|
+
},
|
|
6319
|
+
"companies": {
|
|
6320
|
+
"minItems": 1,
|
|
6321
|
+
"maxItems": 100,
|
|
6322
|
+
"description": "Companies to import, each with its native source currency and metric items. Each company may appear once. Maximum 1000 metric items and 10000 points across the request. Access and currency are checked for every company before any writes.",
|
|
6323
|
+
"type": "array",
|
|
6324
|
+
"items": {
|
|
6325
|
+
"$ref": "#/components/schemas/SdkCompanyMetricImportDto"
|
|
6326
|
+
}
|
|
6327
|
+
},
|
|
6328
|
+
"onConflict": {
|
|
6329
|
+
"type": "string",
|
|
6330
|
+
"enum": [
|
|
6331
|
+
"reject",
|
|
6332
|
+
"overwrite"
|
|
6333
|
+
],
|
|
6334
|
+
"default": "reject",
|
|
6335
|
+
"description": "Default rejects an item if any stored point differs. Identical values are skipped on retries. overwrite explicitly replaces conflicting stored values."
|
|
6336
|
+
}
|
|
6337
|
+
},
|
|
6338
|
+
"required": [
|
|
6339
|
+
"companies"
|
|
6340
|
+
]
|
|
6341
|
+
},
|
|
6342
|
+
"SdkMetricImportResultDto": {
|
|
6343
|
+
"type": "object",
|
|
6344
|
+
"properties": {
|
|
6345
|
+
"index": {
|
|
6346
|
+
"type": "number"
|
|
6347
|
+
},
|
|
6348
|
+
"status": {
|
|
6349
|
+
"type": "string",
|
|
6350
|
+
"enum": [
|
|
6351
|
+
"applied",
|
|
6352
|
+
"unchanged",
|
|
6353
|
+
"error"
|
|
6354
|
+
]
|
|
6355
|
+
},
|
|
6356
|
+
"metricTypeId": {
|
|
6357
|
+
"type": "number"
|
|
6358
|
+
},
|
|
6359
|
+
"metricId": {
|
|
6360
|
+
"type": "number",
|
|
6361
|
+
"description": "Resolved writable actual, forecast or budget row id."
|
|
6362
|
+
},
|
|
6363
|
+
"templateEntryId": {
|
|
6364
|
+
"type": "string"
|
|
6365
|
+
},
|
|
6366
|
+
"flavor": {
|
|
6367
|
+
"type": "string",
|
|
6368
|
+
"enum": [
|
|
6369
|
+
"actual",
|
|
6370
|
+
"forecast",
|
|
6371
|
+
"budget"
|
|
6372
|
+
]
|
|
6373
|
+
},
|
|
6374
|
+
"pointsWritten": {
|
|
6375
|
+
"type": "number"
|
|
6376
|
+
},
|
|
6377
|
+
"pointsUnchanged": {
|
|
6378
|
+
"type": "number"
|
|
6379
|
+
},
|
|
6380
|
+
"actions": {
|
|
6381
|
+
"description": "Committed actions. Failed items roll back their database changes and return no actions or resource ids.",
|
|
6382
|
+
"type": "array",
|
|
6383
|
+
"items": {
|
|
6384
|
+
"type": "string"
|
|
6385
|
+
}
|
|
6386
|
+
},
|
|
6387
|
+
"templateCompanyIds": {
|
|
6388
|
+
"description": "Companies targeted by a template change. Empty if no template mutation is needed. Forecast/budget requests may expand for existing targets.",
|
|
6389
|
+
"type": "array",
|
|
6390
|
+
"items": {
|
|
6391
|
+
"type": "number"
|
|
6392
|
+
}
|
|
6393
|
+
},
|
|
6394
|
+
"errorStatus": {
|
|
6395
|
+
"type": "number"
|
|
6396
|
+
},
|
|
6397
|
+
"error": {
|
|
6398
|
+
"type": "string"
|
|
6399
|
+
}
|
|
6400
|
+
},
|
|
6401
|
+
"required": [
|
|
6402
|
+
"index",
|
|
6403
|
+
"status",
|
|
6404
|
+
"flavor",
|
|
6405
|
+
"pointsWritten",
|
|
6406
|
+
"pointsUnchanged",
|
|
6407
|
+
"actions",
|
|
6408
|
+
"templateCompanyIds"
|
|
6409
|
+
]
|
|
6410
|
+
},
|
|
6411
|
+
"SdkCompanyMetricImportResponseDto": {
|
|
6412
|
+
"type": "object",
|
|
6413
|
+
"properties": {
|
|
6414
|
+
"companyId": {
|
|
6415
|
+
"type": "number"
|
|
6416
|
+
},
|
|
6417
|
+
"currency": {
|
|
6418
|
+
"type": "string"
|
|
6419
|
+
},
|
|
6420
|
+
"success": {
|
|
6421
|
+
"type": "boolean",
|
|
6422
|
+
"description": "True only if every item succeeded."
|
|
6423
|
+
},
|
|
6424
|
+
"results": {
|
|
6425
|
+
"type": "array",
|
|
6426
|
+
"items": {
|
|
6427
|
+
"$ref": "#/components/schemas/SdkMetricImportResultDto"
|
|
6428
|
+
}
|
|
6429
|
+
}
|
|
6430
|
+
},
|
|
6431
|
+
"required": [
|
|
6432
|
+
"companyId",
|
|
6433
|
+
"currency",
|
|
6434
|
+
"success",
|
|
6435
|
+
"results"
|
|
6436
|
+
]
|
|
6437
|
+
},
|
|
6438
|
+
"SdkMetricImportResponseDto": {
|
|
6439
|
+
"type": "object",
|
|
6440
|
+
"properties": {
|
|
6441
|
+
"success": {
|
|
6442
|
+
"type": "boolean",
|
|
6443
|
+
"description": "True only if every item for every company succeeded."
|
|
6444
|
+
},
|
|
6445
|
+
"pointsWritten": {
|
|
6446
|
+
"type": "number",
|
|
6447
|
+
"description": "Total points written across all companies. No point values are echoed."
|
|
6448
|
+
},
|
|
6449
|
+
"pointsUnchanged": {
|
|
6450
|
+
"type": "number"
|
|
6451
|
+
},
|
|
6452
|
+
"companies": {
|
|
6453
|
+
"description": "Company results in request order; each company contains metric results in item order.",
|
|
6454
|
+
"type": "array",
|
|
6455
|
+
"items": {
|
|
6456
|
+
"$ref": "#/components/schemas/SdkCompanyMetricImportResponseDto"
|
|
6457
|
+
}
|
|
6458
|
+
}
|
|
6459
|
+
},
|
|
6460
|
+
"required": [
|
|
6461
|
+
"success",
|
|
6462
|
+
"pointsWritten",
|
|
6463
|
+
"pointsUnchanged",
|
|
6464
|
+
"companies"
|
|
6465
|
+
]
|
|
6466
|
+
},
|
|
6467
|
+
"SdkMetricUsageCompanyDto": {
|
|
6468
|
+
"type": "object",
|
|
6469
|
+
"properties": {
|
|
6470
|
+
"id": {
|
|
6471
|
+
"type": "number"
|
|
6472
|
+
},
|
|
6473
|
+
"name": {
|
|
6474
|
+
"type": "string"
|
|
6475
|
+
}
|
|
6476
|
+
},
|
|
6477
|
+
"required": [
|
|
6478
|
+
"id",
|
|
6479
|
+
"name"
|
|
6480
|
+
]
|
|
6481
|
+
},
|
|
6482
|
+
"SdkMetricTypeUsageDto": {
|
|
6483
|
+
"type": "object",
|
|
6484
|
+
"properties": {
|
|
6485
|
+
"usedInTemplate": {
|
|
6486
|
+
"type": "boolean"
|
|
6487
|
+
},
|
|
6488
|
+
"companyCount": {
|
|
6489
|
+
"type": "number"
|
|
6490
|
+
},
|
|
6491
|
+
"companies": {
|
|
6492
|
+
"type": "array",
|
|
6493
|
+
"items": {
|
|
6494
|
+
"$ref": "#/components/schemas/SdkMetricUsageCompanyDto"
|
|
6495
|
+
}
|
|
6496
|
+
}
|
|
6497
|
+
},
|
|
6498
|
+
"required": [
|
|
6499
|
+
"usedInTemplate",
|
|
6500
|
+
"companyCount",
|
|
6501
|
+
"companies"
|
|
6502
|
+
]
|
|
6503
|
+
},
|
|
6504
|
+
"SdkDeletedMetricTypeDto": {
|
|
6505
|
+
"type": "object",
|
|
6506
|
+
"properties": {
|
|
6507
|
+
"metricTypeId": {
|
|
6508
|
+
"type": "number"
|
|
6509
|
+
}
|
|
6510
|
+
},
|
|
6511
|
+
"required": [
|
|
6512
|
+
"metricTypeId"
|
|
6513
|
+
]
|
|
6514
|
+
},
|
|
6515
|
+
"SdkTemplateCompanyFilterDto": {
|
|
6516
|
+
"type": "object",
|
|
6517
|
+
"properties": {
|
|
6518
|
+
"type": {
|
|
6519
|
+
"type": "string",
|
|
6520
|
+
"enum": [
|
|
6521
|
+
"all",
|
|
6522
|
+
"group",
|
|
6523
|
+
"company"
|
|
6524
|
+
],
|
|
6525
|
+
"description": "Selectors are OR-combined. all means the whole VC portfolio and requires VC admin access."
|
|
6526
|
+
},
|
|
6527
|
+
"value": {
|
|
6528
|
+
"type": "number",
|
|
6529
|
+
"description": "Company or company-group id; omit for all."
|
|
6530
|
+
}
|
|
6531
|
+
},
|
|
6532
|
+
"required": [
|
|
6533
|
+
"type"
|
|
6534
|
+
]
|
|
6535
|
+
},
|
|
6536
|
+
"SdkTemplateEntryDto": {
|
|
6537
|
+
"type": "object",
|
|
6538
|
+
"properties": {
|
|
6539
|
+
"metricTypeId": {
|
|
6540
|
+
"type": "number",
|
|
6541
|
+
"description": "Accessible predefined or VC-owned custom type. Cannot change on update."
|
|
6542
|
+
},
|
|
6543
|
+
"hasForecast": {
|
|
6544
|
+
"type": "boolean"
|
|
6545
|
+
},
|
|
6546
|
+
"hasBudget": {
|
|
6547
|
+
"type": "boolean"
|
|
6548
|
+
},
|
|
6549
|
+
"companyFilter": {
|
|
6550
|
+
"minItems": 1,
|
|
6551
|
+
"maxItems": 250,
|
|
6552
|
+
"type": "array",
|
|
6553
|
+
"items": {
|
|
6554
|
+
"$ref": "#/components/schemas/SdkTemplateCompanyFilterDto"
|
|
6555
|
+
}
|
|
6556
|
+
},
|
|
6557
|
+
"position": {
|
|
6558
|
+
"type": "number",
|
|
6559
|
+
"minimum": 0
|
|
6560
|
+
},
|
|
6561
|
+
"id": {
|
|
6562
|
+
"type": "string"
|
|
6563
|
+
},
|
|
6564
|
+
"metricTemplateId": {
|
|
6565
|
+
"type": "string"
|
|
6566
|
+
}
|
|
6567
|
+
},
|
|
6568
|
+
"required": [
|
|
6569
|
+
"metricTypeId",
|
|
6570
|
+
"hasForecast",
|
|
6571
|
+
"hasBudget",
|
|
6572
|
+
"companyFilter",
|
|
6573
|
+
"id",
|
|
6574
|
+
"metricTemplateId"
|
|
6575
|
+
]
|
|
6576
|
+
},
|
|
6577
|
+
"SdkMetricTemplateDto": {
|
|
6578
|
+
"type": "object",
|
|
6579
|
+
"properties": {
|
|
6580
|
+
"id": {
|
|
6581
|
+
"type": "string"
|
|
6582
|
+
},
|
|
6583
|
+
"entries": {
|
|
6584
|
+
"type": "array",
|
|
6585
|
+
"items": {
|
|
6586
|
+
"$ref": "#/components/schemas/SdkTemplateEntryDto"
|
|
6587
|
+
}
|
|
6588
|
+
}
|
|
6589
|
+
},
|
|
6590
|
+
"required": [
|
|
6591
|
+
"id",
|
|
6592
|
+
"entries"
|
|
6593
|
+
]
|
|
6594
|
+
},
|
|
6595
|
+
"SdkTemplateEntryWriteDto": {
|
|
6596
|
+
"type": "object",
|
|
6597
|
+
"properties": {
|
|
6598
|
+
"metricTypeId": {
|
|
6599
|
+
"type": "number",
|
|
6600
|
+
"description": "Accessible predefined or VC-owned custom type. Cannot change on update."
|
|
6601
|
+
},
|
|
6602
|
+
"hasForecast": {
|
|
6603
|
+
"type": "boolean"
|
|
6604
|
+
},
|
|
6605
|
+
"hasBudget": {
|
|
6606
|
+
"type": "boolean"
|
|
6607
|
+
},
|
|
6608
|
+
"companyFilter": {
|
|
6609
|
+
"minItems": 1,
|
|
6610
|
+
"maxItems": 250,
|
|
6611
|
+
"type": "array",
|
|
6612
|
+
"items": {
|
|
6613
|
+
"$ref": "#/components/schemas/SdkTemplateCompanyFilterDto"
|
|
6614
|
+
}
|
|
6615
|
+
},
|
|
6616
|
+
"position": {
|
|
6617
|
+
"type": "number",
|
|
6618
|
+
"minimum": 0
|
|
6619
|
+
}
|
|
6620
|
+
},
|
|
6621
|
+
"required": [
|
|
6622
|
+
"metricTypeId",
|
|
6623
|
+
"hasForecast",
|
|
6624
|
+
"hasBudget",
|
|
6625
|
+
"companyFilter"
|
|
6626
|
+
]
|
|
6627
|
+
},
|
|
6628
|
+
"SdkDeletedMetricDto": {
|
|
6629
|
+
"type": "object",
|
|
6630
|
+
"properties": {
|
|
6631
|
+
"metricId": {
|
|
6632
|
+
"type": "number"
|
|
6633
|
+
},
|
|
6634
|
+
"companyId": {
|
|
6635
|
+
"type": "number"
|
|
6636
|
+
}
|
|
6637
|
+
},
|
|
6638
|
+
"required": [
|
|
6639
|
+
"metricId",
|
|
6640
|
+
"companyId"
|
|
6641
|
+
]
|
|
6642
|
+
},
|
|
6016
6643
|
"SdkReportSectionType": {
|
|
6017
6644
|
"type": "string",
|
|
6018
6645
|
"enum": [
|