Get the segment builder catalog

GET

segments

catalog

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.segments.catalog();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "activities": [
    {
      "action": "sent",
      "label": "<string>",
      "supportsLink": true,
      "supportsScope": true,
      "supportsWindow": true
    }
  ],
  "fields": [
    {
      "description": "<string>",
      "field": "<string>",
      "group": "attributes",
      "kind": "text",
      "label": "<string>",
      "operators": [
        {
          "input": "none",
          "label": "<string>",
          "op": "eq"
        }
      ],
      "source": "system",
      "optionSource": "groups",
      "options": [
        "<string>"
      ]
    }
  ],
  "object": "segment_catalog"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Response

activities

SegmentActivityCatalogItem · object[]

required

Activity rule choices supported by the audience grammar.

Show child attributes

fields

SegmentCatalogField · object[]

required

Every active system and custom field that can be used in a segment.

Show child attributes

object

any

default:segment_catalog

Always "segment_catalog".

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.segments.catalog();
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "activities": [
    {
      "action": "sent",
      "label": "<string>",
      "supportsLink": true,
      "supportsScope": true,
      "supportsWindow": true
    }
  ],
  "fields": [
    {
      "description": "<string>",
      "field": "<string>",
      "group": "attributes",
      "kind": "text",
      "label": "<string>",
      "operators": [
        {
          "input": "none",
          "label": "<string>",
          "op": "eq"
        }
      ],
      "source": "system",
      "optionSource": "groups",
      "options": [
        "<string>"
      ]
    }
  ],
  "object": "segment_catalog"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Get the segment builder catalog

Authorizations

Response