Beta Programs
Customer Segmentation
Segments for a Shopper Profile

Segments API (Beta)

Get All Segments for a Shopper Profile (Beta)

GET /shopper-profiles/{shopperProfileId}/segments

Request

Returns a paginated Segments list for a Shopper Profile.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • page in query - integer

    Page number.

  • limit in query - integer

    Items count per page.

example

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

Did you find what you were looking for?