List views

GET /views
Api key

Returns the list of views available to your perimeter.

A view in Deck is an object to tell what product information should be displayed, in what area (called "zones"), and in which order. The finesse of this configuration is up to the PIM admins and can depend on product segments and classification. But in the end, on the API side, it is a ready-to-use indication to drive information display.

Information can be properties, tiles, localized fields.

Here are some examples:

  • the view "web" would be used to give the instructions of what to display on the different zones of the product web page
  • the view "technical-sheet" would do that for the technical sheet generation, which is a bit different.
  • The view "compare" would be used to specified the criteria useful during product comparison, using zones to define parameters categories

Responses

  • 200 application/json

    Successfully returned available views

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

      Additional properties are allowed.

      Hide result attribute Show result attribute object
      • views array[object]
        Hide views attributes Show views attributes object
        • key String

          The unique key to identify this view

        • trads object

          Translations for the object. Available languages depend on your corporation settings

          Additional properties are allowed.

          Hide trads attributes Show trads attributes object
        • api_get_view url

          The API endpoint to get detailed information for this view
GET /views 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/views \
 -H "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "views": [
      {
        "key": "web",
        "trads": {
          "en": "Web view to control website",
          "fr": "Vue site web"
        },
        "api_get_view": "/api/v1/views/web"
      },
      {
        "key": "compare",
        "name": "Comparision view to know relevant criteria",
        "trads": {
          "en": "Comparision view",
          "fr": "Vue comparison"
        },
        "api_get_view": "/api/v1/views/compare"
      }
    ]
  }
}