Skip to main content
GET
List segments

Authorizations

x-bigco-hmac-sha256
string
header
required

Base64-encoded HMAC-SHA256 signature of the request. Every request must also include the x-bigco-hmac-username and x-date headers, and POST/PUT requests must include x-digest. See the Authentication guide for the full signing procedure.

Response

Your brand's segments.

id
integer
required
Example:

123

brand_id
integer
required
Example:

37876

name
string
required

The segment name, unique within your brand.

Example:

"Loyal customers"

source
string
required

Where the segment originated (e.g. USER_DEFINED, KLAVIYO).

Example:

"USER_DEFINED"

type
string
required

The segment type (e.g. STANDARD, POINT IN TIME).

Example:

"STANDARD"

is_active
boolean
required
Example:

true

is_archived
boolean
default:false
required
Example:

false

criteria
object[]
required
date_created
string<date-time>
required
Example:

"2024-01-12T15:21:51Z"

date_last_updated
string<date-time>
required
Example:

"2024-01-12T15:21:51Z"

description
string | null
Example:

"Customers with 3+ orders"

is_pinned
boolean | null
Example:

false

color_id
integer | null
Example:

3

ltv
number | null

Average lifetime value of users in the segment.

Example:

250

average_order_value
number | null
Example:

75.5

average_purchase_frequency
number | null
Example:

2.4