FLfloqer
ackDB

Get the default view for a kind

Returns the default table view for a kind: a Segment explicitly marked default (source 'explicit') or the server-computed catalog fallback (source 'computed', id null). Always returns usable columns+sort so clients never hard-code the column policy.

get/api/v1/ackdb/observe/segments/default

Request

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

Query parameters

entityKind'company' | 'contact' | 'person'

Which kind's default to return (defaults to 'company').

Response

The default view (explicit or computed).

Example response

{
  "data": {
    "id": "01J9Z8Q3K2X7M4N5P6R7S8T9V0",
    "name": "Active paying companies",
    "entityKind": "company",
    "filter": {
      "children": [
        {
          "traitKey": "hubspot_lifecycle_stage"
        }
      ]
    },
    "sort": [
      {
        "field": "event_count"
      }
    ],
    "columns": [
      {
        "field": "name",
        "frozen": true,
        "width": 200
      }
    ],
    "isDefault": true,
    "source": "computed"
  }
}

Changes

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