Deck API

Guide results ⏏️

GET /navigation/guide/{search_id}/{locale}/results

Get search results and search filters for the latest step of a given search.

It can be called at the end of the guide (when there is no question left) but can also be called any time during the guided search.

If called regularly, it is recommended to activate the pagination mechanism by providing a page number - starting at 1. Default slice page is 25, but it can be refined with the slice parameter.

Responses

• 200 object

Successfully returned results for a given search (filters + products)
- status string
- result object
  context object
  
  locale string
  
  Available languages depend on your corporation settings
  
  Value is en fr it es de hu ja be pt es fi ro tr pt-BR es-AR.
  
  search_id string
  
  The search_id include all user choices, built or edited at each stage of the search guide
  
  custom_pictos_only boolean
  
  True if only custom pictograms are returned, but not Deck default pictograms
  
  step integer
  
  The current step of the search, to be used to identify the question we're answering to
  
  product_count integer
  
  Total product count at current step
  
  api_follow_guide url
  
  The API endpoint to follow search guide while there are still some steps to follow
  
  api_refine_guide url
  
  The API endpoint to refine your search once you followed all the steps
  
  api_guide_results url
  
  The API endpoint to get search guide results
  
  filters array[object]
  
  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.
  
  key string
  
  Unique key to identify the filter
  
  name string
  
  Filter key translation (depending of the locale)
  
  combination_mode string
  
  The value for this property can be:
  
  "none" --> Single choice
  
  "and" OR "or" --> Multiple choice --> "choice_1~choice_2" OR "choice_1|choice_2"
  
  picto_url string
  
  The URL of the filter pictogram
  
  values array[object]
  
  key string
  
  Unique key to identify the value
  
  name string
  
  value key translation (depending of the locale)
  
  picto_url string
  
  The URL of the value pictogram
  
  query_string string
  
  The query_string URL compatible version of the filter, to provide in optional_filters for example
  
  products array[object]
  
  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.
  
  id string
  
  Id to identify the product, unique segment-wise
  
  name string
  
  The name of the product
  
  level string
  
  The level of the product in the product hierarchy. Products which are not part of any hierarchy are marked as 'single'
  
  Values are single, parent, or variant.
  
  last_modified date
  
  Date of last modification on product
  
  api_get_product url
  
  The API endpoint to get all information on the product
  
  main_picture_url url
  
  The URL of the main picture for the product
  
  product_page_url url
  
  The URL of the public product page

GET /navigation/guide/{search_id}/{locale}/results

curl \
 -X GET https://api.ppe-analytics.com/api/v1/navigation/guide/2e254ef2-3e63-4cb2-9680-3876b68e7191/it/results \
 -H "PPEApiKey: $API_KEY"

Response example (200)

{
  "status": "OK",
  "result": {
    "context": {
      "locale": "fr",
      "search_id": "2e254ef2-3e63-4cb2-9680-3876b68e7191",
      "custom_pictos_only": true,
      "step": 4,
      "product_count": 50,
      "api_refine_guide": "/api/v1/navigation/guide/2e254ef2-3e63-4cb2-9680-3876b68e7191/fr/follow/current?choice_key=_refine_"
    },
    "filters": [
      {
        "segment_key": "head-protection",
        "key": "colour",
        "name": "Couleur",
        "combination_mode": "or",
        "picto_url": "https://app.ppe-analytics.com/static/pictures/300/head-protection/89e6848c8f1f91404c224393340b1fad.jpg",
        "values": [
          {
            "key": "white",
            "name": "Blanc",
            "picto_url": "https://app.ppe-analytics.com/static/pictures/300/head-protection/89e6848c8f1f91404c224393340b1fad.jpg"
          },
          {
            "key": "black",
            "name": "Noir",
            "picto_url": "https://app.ppe-analytics.com/static/pictures/300/head-protection/89e6848c8f1f91404c224393340b1fad.jpg"
          }
        ],
        "query_string": "colour~white_black"
      }
    ],
    "products": [
      {
        "segment_key": "head-protection",
        "id": "f50938a24830edb8b1c2ecc3f7dd88a3",
        "name": "Awesome light 123",
        "level": "single",
        "api_get_product": "/api/v1/product/lightening/f50938a24830edb8b1c2ecc3f7dd88a3",
        "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/lightening/f50938a24830edb8b1c2ecc3f7dd88a3.jpg",
        "product_page_url": "https://my-website.it/lightening/f50938a24830edb8b1c2ecc3f7dd88a3"
      },
      {
        "segment_key": "head-protection",
        "id": "89e6848c8f1f91404c224393340b1fad",
        "name": "Awesome helmet 1234",
        "level": "variant",
        "api_get_product": "/api/v1/product/head-protection/89e6848c8f1f91404c224393340b1fad",
        "main_picture_url": "https://app.ppe-analytics.com/static/pictures/300/head-protection/89e6848c8f1f91404c224393340b1fad.jpg",
        "product_page_url": "https://my-website.it/head-protection/89e6848c8f1f91404c224393340b1fad"
      }
    ]
  }
}

Guide results ⏏️

Path parameters

Query parameters

Responses