Value Metrics

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.

post/value-metric

Request

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

Request body

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 request

{
  "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"
}

Response

ValueMetrics - Created record

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.