Docs
Management API
Customer segmentation
Segments for a Shopper Profile

Segments for a Shopper Profile

Get All Segments for a Shopper Profile

GET /shopper-profiles/{shopperProfileId}/segments

Request

Returns a paginated Segments list for a Shopper Profile.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • shopperProfileId in path - string
    required
    The Shopper Profile ID.
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/shopper-profiles/[shopperProfileId]/segments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

An array of Segments objects and metadata.

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[object]

  • meta    object

    Data about the response including pagination, and collection totals.

example

{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Segment",
"description": "Description",
"created_at": "2022-09-15T23:44:05Z",
"updated_at": "2022-09-15T23:44:05Z"
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 50,
"current_page": 1,
"total_pages": 1
}
}
}
Did you find what you were looking for?
Delete SegmentsGet All Segments for a Shopper Profile