Value Metrics

Get ValueMetrics list

Lists metric records, optionally filtered by year and month query parameters for use in dashboard charts and time-series widgets.

get/value-metric

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/value-metric
  • Auth: HTTP bearer

Query parameters

yearstring

Year for which data to select

monthstring

Month for which data to select

filterstring

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.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

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.

Response

Value metrics records list

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

updatedstring date-time

Last updated timestamp

updatedUserIdinteger

ID of user who last updated this record

makeScenarioIdinteger required

ID of the Make (Integrator) scenario that triggers this metric increment

valuenumber float required

The numeric amount to add to the metric each time this module runs; can be a fixed number or dynamically sourced from other modules. Stored as decimal(20,6).

aiTokensLogboolean

When true, the value amount is deducted from the organization AI Credits quota instead of incrementing the metric.

labelstring

The name of the metric or event being tracked (e.g. ‘New Lead’, ‘Sale Completed’).

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "updated": "2026-01-15T09:30:00Z",
    "updatedUserId": 42,
    "makeScenarioId": 42,
    "value": 1.5,
    "aiTokensLog": true,
    "label": "string"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.