Skip to main content
GET
Custom Metrics by CUIT

Overview

Returns densified incremental metrics for a calendar lookback ending on a reference date: deltas, % change, daily variance, acceleration when enough history exists, and completeness. One billable request per successful call when priced. Provide lookback (integer 1–180) or a window preset (w_1dw_180d). If both are sent, lookback wins.

Window math

Example: lookback=4&date=2026-07-142026-07-11 … 2026-07-14 (four days). The date is included. Quiet days may be sparse upstream; on HTTP 200 the API returns a dense series (forward-fill): unchanged days keep prior totals with daily delta 0. A flat series with delta 0 means no movement, not “missing data”. Only evaluate thresholds when complete === true.

Endpoint

Path parameters

string
required
Argentina CUIT/CUIL — 11 digits, no dashes.

Query parameters

At least one of lookback or window is required.
integer
Calendar days in the window (1–180, inclusive). Optional if window is set.
string
Optional lookback preset that resolves to calendar days:
string
Optional. Inclusive window end (YYYY-MM-DD). Defaults to latest corpus date when omitted.

Success response (HTTP 200)

Account stock aliases:
  • cbuCount, cvuCount, totalAccountslast densified day (windowEnd / referenceDate)
  • cbuCountAtStart, cvuCountAtStartfirst densified day (windowStart)
Optional daily[]: exactly lookbackDays densified rows when present (debugging / day-level rules). How to read % / deltas: cbuDelta / cvuDelta are end − start for the whole window (not a sum of internal churn). totalDelta is cbuDelta + cvuDelta. cbuPctChange / cvuPctChange are null when that channel’s start = 0; totalPctChange is null when combined start stock (totalAccountsStart) = 0 (do not treat null as 0). When accelerationAvailable is false, ignore acceleration fields (null). daysWithChanges counts densified days with daily CBU or CVU delta ≠ 0. Gate: only score when HTTP 200 and data.complete === true. Do not treat HTTP 422 as “zero change”.
boolean
true
boolean
Always true on success.
number
Resolved lookback (from lookback or window preset).
string
Inclusive window end (YYYY-MM-DD).
string
Window start date (YYYY-MM-DD).
string
Window end date (YYYY-MM-DD), same as reference date.
object
  • cbuTotalStart, cbuTotalEnd, cvuTotalStart, cvuTotalEnd (numbers)
  • totalAccountsStart, totalAccountsEnd (numbers) — CBU + CVU stock at window start/end
  • cbuDelta, cvuDelta, totalDelta (numbers) — totalDelta = cbuDelta + cvuDelta
  • cbuPctChange, cvuPctChange, totalPctChange (number | null)
  • daysWithChanges (number)
  • cbuDailyDeltaVariance, cvuDailyDeltaVariance (number | null)
  • cbuAcceleration, cvuAcceleration, totalAcceleration (number | null)
  • accelerationAvailable (boolean) — when false, acceleration fields are null

Incomplete window (HTTP 422)

When the densified window cannot be built (missing floor for forward-fill, corpus day not marked complete, or no incremental state), the API returns success: false with a partial data payload. Do not apply threshold rules — this is “data not ready”, not a zero score.

Other errors

Example

Rules engine

Metrics conditions require holderIntelligenceLookbackDays (1–180) on the rule condition. An explicit metrics.complete == true condition is unnecessary: incomplete windows expose metrics as null, and the engine evaluates them as non-matches. For acceleration, add metrics.acceleration_available == true. Never treat incomplete / null metrics as zero. Transaction rules: the reference date defaults to transactedAt converted to Argentina calendar date unless you set holderIntelligenceReferenceDateField on the condition. See Rules conditions.