ackDB

What this server's score validator accepts

The scoring contract: aggregate reducers (with the grains and scoring modes each allows), match operators, normalizations, percentile populations, convergence modes and every numeric limit. Builders should render from this rather than probing for support by saving throwaway definitions. Note eventValueMatching: match compares event metadata EXACTLY (case-sensitive), the same way segment filters do — seed value pickers from /fields/{key}/values instead of accepting free text (#438).

get/api/v1/ackdb/scores/capabilities

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Response

The scoring capability contract.

grainsstring[] required

Grains a definition can be created on.

matchOpsstring[] required

Match operators the validator accepts, on every matchable field kind.

normalizationsstring[] required
percentilePopulationsstring[] required

Percentile ranking populations (#432). Rejected on absolute definitions.

convergenceModesstring[] required

Convergence list shapes, exactly one per criterion (#414 sources, #421 signals).

eventValueMatching'exact' required

How match values compare against event metadata: exact and case-sensitive, the way segment filters compare them (#380 canonicalizes trait values and deliberately left event fields exact). Seed value pickers from /fields/{key}/values rather than accepting free text, since a value differing only in case scores 0.

Example response

{
  "limits": {
    "criteria": 50,
    "groups": 10,
    "points": 100,
    "windowDays": 3650,
    "convergenceWindowDays": 365,
    "convergenceSignals": 20
  }
}

Changes

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