Get values 📋

View as Markdown
GET /products/values/{property_key}
Api key

Returns the values for a given property on a list of products

By default all the products of the perimeter with a value on this property will be returned, but the population can be reduced using filters.

Path parameters

  • property_key string Required

    The property key for which to get the values, as returned by segment datamodel endpoint.

    If it is a public property, it must be prefixed by the segment slug + '--', for example hand-protection--en388-digits.

    Otherwise it will look for private properties

Query parameters

  • filters

    Optional filters that will reduce the product population and only provide values for the products matching the filters. Filter example: en388-cut~d

    Filters can be cumulated with the query string array syntax: ?filters[]=prop1~foo&filters[]=prop2~bar

    Filters on string properties must provide the exact value, case sensitive. Loose search is not permitted yet.

    In the filter, if the value is omitted after the ~, the filter will return all products having at least a value for the property.

GET /products/values/{property_key} 
curl \
 --request GET 'https://api.ppe-analytics.com/api/v1/products/values/acme-product-ranking' \
 --header "PPEApiKey: $API_KEY"