SDK API Reference / Segment

Interface: Segment

Child segment response - Flat format (not JSON:API)

Properties

audienceId

audienceId: string

---

createdAt?

optional createdAt: string

---

createdBy?

optional createdBy: object

id

id: string

name

name: string

td_user_id

td_user_id: string

---

description?

optional description: string

---

id

id: string

---

isVisible?

optional isVisible: boolean

---

kind?

optional kind: number

---

name

name: string

---

numSyndications?

optional numSyndications: number

---

population?

optional population: number

---

realtime?

optional realtime: boolean

---

referencedBy?

optional referencedBy: unknown[]

---

rule?

optional rule: object

conditions?

optional conditions: unknown[]

description?

optional description: string

type

type: string

---

segmentFolderId?

optional segmentFolderId: string

---

sql?

optional sql: string

---

updatedAt?

optional updatedAt: string

---

updatedBy?

optional updatedBy: object

id

id: string

name

name: string

td_user_id

td_user_id: string