Get view

GET /views/{view_key}
Api key

Get the full information about a view (for more information about what is a view, see List views endpoint above)

For each segment, all zones and the items in each zone are provided in the correct order.

Some items can be seen in different segments and zones.

Query parameters

  • with_json_path boolean

    Set to "1" to also request api endpoint + json path for each item in the view, allosing easier query of detailed items attributes

Responses

  • 200 application/json

    Successfully returned view

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

      Additional properties are allowed.

      Hide result attributes Show result attributes object
      • view object

        Additional properties are allowed.

        Hide view attributes Show view 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

      • zones array[object]
        Hide zones attributes Show zones attributes object
        • key String

          The key to identify this zone in the 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
        • rank integer

          The rank of the zone inside the view

      • segments object

        Additional properties are allowed.

        Hide segments attributes Show segments attributes object
        • hand-protection object

          Additional properties are allowed.

          Hide hand-protection attributes Show hand-protection attributes object
          • zone1 array[object]

            The content of a zone

            Hide zone1 attributes Show zone1 attributes object
            • type string

              The type of the item in the view, to know in which kind of object to look for

              Values are property, tile, or localized-field.

            • rank integer

              The rank of the item inside the zone

            • key string

              The unique key to designate the item found in the view + zone

          • zone2 array[object]

            The content of another zone

            Hide zone2 attributes Show zone2 attributes object
            • type string

              The type of the item in the view, to know in which kind of object to look for

              Values are property, tile, or localized-field.

            • rank integer

              The rank of the item inside the zone

            • key string

              The unique key to designate the item found in the view + zone

        • foot-protection object

          Additional properties are allowed.

          Hide foot-protection attributes Show foot-protection attributes object
          • zone1 array[object]

            The content of a zone

            Hide zone1 attributes Show zone1 attributes object
            • type string

              The type of the item in the view, to know in which kind of object to look for

              Values are property, tile, or localized-field.

            • rank integer

              The rank of the item inside the zone

            • key string

              The unique key to designate the item found in the view + zone

          • zone2 array[object]

            The content of another zone

            Hide zone2 attributes Show zone2 attributes object
            • type string

              The type of the item in the view, to know in which kind of object to look for

              Values are property, tile, or localized-field.

            • rank integer

              The rank of the item inside the zone

            • key string

              The unique key to designate the item found in the view + zone
GET /views/{view_key} 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/views/{view_key} \
 -H "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "view": {
      "key": "web",
      "trads": {
        "en": "Web view to control website",
        "fr": "Vue site web"
      }
    },
    "zones": [
      {
        "key": "norms",
        "rank": 0,
        "trads": {
          "en": "Norms",
          "fr": "Normes"
        }
      },
      {
        "key": "advantages",
        "rank": 1,
        "trads": {
          "en": "Advantages",
          "fr": "Avantages"
        }
      }
    ],
    "segments": {
      "foot-protection": {
        "norms": [
          {
            "key": "en20345",
            "rank": 0,
            "type": "property"
          }
        ],
        "default": [
          {
            "key": "technical-name",
            "rank": 0,
            "type": "property"
          }
        ]
      },
      "hand-protection": {
        "norms": [
          {
            "key": "en388",
            "rank": 0,
            "type": "property"
          },
          {
            "key": "tile-900",
            "rank": 1,
            "type": "tile"
          }
        ],
        "default": [
          {
            "key": "technical-name",
            "rank": 0,
            "type": "property"
          }
        ],
        "advantages": [
          {
            "key": "acme--fabdis-desc-32",
            "rank": 0,
            "type": "localized-field"
          },
          {
            "key": "mycorp/comfort",
            "rank": 1,
            "type": "property"
          }
        ]
      }
    }
  }
}