Guide results ⏏️

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

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.

Path parameters

  • search_id string Required

    The search_id as returned by the Follow guide endpoint.

  • locale string Required

    The locale in which to receive the results. 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.

Query parameters

  • page integer

    The rank of the requested page, starting at 1.

  • slice integer

    The size of the slice requested. Default value is 25.

Responses

  • 200 application/json

    Successfully returned results for a given search (filters + products)

    Hide response attributes Show response attributes object
    • status string
    • result object

      Additional properties are allowed.

      Hide result attributes Show result attributes object
      • context object

        Additional properties are allowed.

      • filters array[object]
        Hide filters attributes Show filters attributes 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]
          Hide values attributes Show values attributes 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]
        Hide products attributes Show products attributes 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

        • manufacturer string

          The manufacturer key for 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

        • parent_id string

          The id of the parent product (if level is "variant")

        • 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

        • pim_status string

          The status of the product in the PIM. It is only available on products on which your are the owner

          Values are draft, ready, or archived.
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 examples (200) 
{
  "status": "OK",
  "result": {
    "context": {
      "step": 4,
      "locale": "fr",
      "search_id": "2e254ef2-3e63-4cb2-9680-3876b68e7191",
      "product_count": 50,
      "api_refine_guide": "/api/v1/navigation/guide/2e254ef2-3e63-4cb2-9680-3876b68e7191/fr/follow/current?choice_key=_refine_",
      "custom_pictos_only": true
    },
    "filters": [
      {
        "key": "colour",
        "name": "Couleur",
        "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"
          }
        ],
        "picto_url": "https://app.ppe-analytics.com/static/pictures/300/head-protection/89e6848c8f1f91404c224393340b1fad.jpg",
        "segment_key": "head-protection",
        "query_string": "colour~white_black",
        "combination_mode": "or"
      }
    ],
    "products": [
      {
        "id": "f50938a24830edb8b1c2ecc3f7dd88a3",
        "name": "Awesome light 123",
        "level": "single",
        "segment_key": "head-protection",
        "manufacturer": "petzl",
        "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"
      },
      {
        "id": "89e6848c8f1f91404c224393340b1fad",
        "name": "Awesome helmet 1234",
        "level": "variant",
        "segment_key": "head-protection",
        "manufacturer": "jsp",
        "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"
      }
    ]
  }
}