Metorik Docs

Segments

Segments

Returns store-wide saved segments for a store resource.

GET /api/v1/store/segments

Segments

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/segments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "id": 101,
      "name": "High Value Orders",
      "description": null,
      "resource": "orders",
      "match": "all",
      "filters": {},
      "store_wide": true,
      "is_preset": false
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 50,
    "has_more_pages": false
  }
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

  • page integer

    Page number. Min 1. Example: 1

  • per_page integer

    Number of segments per page. Min 1, max 100. Defaults to 50. Example: 50

  • resource string enum required

    Segment resource. Example: orders

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • data[] object array
    + Show Child Attributes
    • id integer
    • name string
    • description string nullable
    • resource string
    • match string
    • filters array
    • store_wide boolean
    • is_preset boolean
  • pagination object
    + Show Child Attributes
    • current_page integer
    • per_page integer
    • has_more_pages boolean