Get values 📋

GET /products/values/{property_key}
Api key

Returns the values of all the products of the perimeter for a given property.

Path parameters

  • property_key string Required

    The property key for which to get the values, as returned by segment datamodel endpoint. If it depends of a segment, it must be prefixed by the segment slug separated by '--'

Responses

  • • 200 application/json

    Successfully returned property values

    Hide response attributes Show response attributes object
    • status string
    • result object
      Hide result attribute Show result attribute
      • values array[object]
        Hide values attributes Show values attributes object
        • product_segment_key string

          Unique slug to identify the segment

          Values are hand-protection, foot-protection, head-protection, eye-protection, body-protection, ear-protection, fall-protection, respiratory-protection, ergonomy, safety-first-aid, hygiene, lockout-tagout, electrical, lightening, safety-signs, or surface-cleaning.

        • product_id string

          Id to identify the product, unique segment-wise

        • value string

          The value for this property can be:

          • a value_key for enum
          • an array of value_key for enum_list
          • a string otherwise
  • • 404
  • • 403
GET /products/values/{property_key} 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/products/values/hand-protection--color \
 -H "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "values": [
      {
        "product_segment_key": "surface-cleaning",
        "product_id": "f50938a24830edb8b1c2ecc3f7dd88a3",
        "value": [
          "one",
          "two"
        ]
      },
      {
        "product_segment_key": "surface-cleaning",
        "product_id": "89e6848c8f1f91404c224393340b1fad",
        "value": [
          "three"
        ]
      },
      {
        "product_segment_key": "surface-cleaning",
        "product_id": "79e6848c8f1f91404c224393340b1fad",
        "value": [
          "one"
        ]
      }
    ]
  }
}