AckdbFieldDescriptor

A catalog field available for filtering/sorting/projection in Observe. Coverage is the count of active companies with a value for this field. `group` distinguishes system attributes, traits, and event types.

Properties

keystringrequired

labelstringrequired

groupstringrequired

"system""trait""event"

valueTypestringrequired

"string""number""boolean""date""string_array"

sourcestringrequired

coverageintegerrequired

sortablebooleanrequired

filterablebooleanrequired

operatorsarray ofrequired

Operators legal for this field (trait/attribute operators or event predicates).

string

allowedValuesarray | null

Enum constraint from the trait definition, if any.

distinctValuesUrlstring

Present only when the field supports a distinct-value picker (string/string_array traits, whitelisted system attributes, string/string_array emf__ columns) - the grain-correct URL to fetch values from. Absent means free-text input.

Example

AckdbFieldDescriptor example

{
  "key": "event_count",
  "label": "Event Count",
  "group": "system",
  "valueType": "string",
  "source": "system",
  "coverage": 1280,
  "sortable": true,
  "filterable": true,
  "operators": [
    "string"
  ],
  "allowedValues": null,
  "distinctValuesUrl": "/observe/companies/fields/hubspot_lifecycle_stage/values"
}