ValueMetrics
> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.
create
POST /value-metric
Track ValueMetric — Records a metric value for the given Make scenario. If a record for the same makeScenarioId already exists for the current date, the value is added to the existing record rather than creating a new one.
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes | Value Metrics to be created |
Returns: ValueMetric · Cost: 1 API call.
list
GET /value-metric
Get ValueMetrics list — Lists metric records, optionally filtered by year and month query parameters for use in dashboard charts and time-series widgets.
| Parameter | In | Required | Description |
|---|---|---|---|
year |
query | no | Year for which data to select |
month |
query | no | Month for which data to select |
filter |
query | no | Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5. |
offset |
query | no | Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30. |
limit |
query | no | Maximum number of records to return. Use together with offset for pagination. |
order |
query | no | Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC. |
Returns: list<ValueMetric> · Cost: 1 API call per page (lazy paginator).