Skip to content

SegmentInfo ​

Type: schema

TypeScript Definition ​

typescript
SegmentInfo: {{
            /** @description segment id */
            id?: $Read<string>;
            /** @description segment name */
            name: string;
            /** @enum {unknown} */
            segment_type: "dynamic" | "manual";
            /**
             * @description default status is draft
             * @enum {unknown}
             */
            status?: "draft" | "active" | "inactive" | "archived";
            tags?: string[] | null;
            /** @description meta data in key-value pair. example - [{"key":"value"}] */
            meta?: Record<string, never>[];
            description?: string;
            /** @default 0 */
            people_count: $Read<number>;
            /**
             * @description Number of audience members in the segment. (Backend emits this; `people_count` is the legacy name.)
             * @default 0
             */
            audience_count: $Read<number>;
            /** @description Rule tree for a `dynamic` segment (maps to the backend `data_driven_condition`). `null` for manual segments. */
            dynamic_conditions?: Record<string, never> | null;
            /** @default 0 */
            usage_count: $Read<number>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
            /** Format: date-time */
            archived_at?: string | null;
        };
        /**
         * SellerAccount
         * @description A marketplace seller's account, with its `channel_id` and its KYC documents; custom fields the marketplace's seller form defines appear as extra top-level fields.
         */
}

OpenAPI Schema ​

json
{
  "title": "SegmentInfo",
  "type": "object",
  "required": [
    "name",
    "segment_type"
  ],
  "properties": {
    "id": {
      "description": "segment id",
      "type": "string",
      "readOnly": true
    },
    "name": {
      "description": "segment name",
      "type": "string"
    },
    "segment_type": {
      "enum": [
        "dynamic",
        "manual"
      ]
    },
    "status": {
      "description": "default status is draft",
      "enum": [
        "draft",
        "active",
        "inactive",
        "archived"
      ]
    },
    "tags": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "description": "meta data in key-value pair. example - [{\"key\":\"value\"}]",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "description": {
      "type": "string"
    },
    "people_count": {
      "type": "integer",
      "default": 0,
      "readOnly": true
    },
    "audience_count": {
      "description": "Number of audience members in the segment. (Backend emits this; `people_count` is the legacy name.)",
      "type": "integer",
      "default": 0,
      "readOnly": true
    },
    "dynamic_conditions": {
      "description": "Rule tree for a `dynamic` segment (maps to the backend `data_driven_condition`). `null` for manual segments.",
      "type": [
        "object",
        "null"
      ]
    },
    "usage_count": {
      "type": "integer",
      "default": 0,
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "archived_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "x-tags": [
    "Segments"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: