List localized fields

GET /localized-fields
Api key

Returns the list of localized fields available to your perimeter.

A localized field is a data type used to store information about a product, as free text but in multiple languages.

Is is identified by a unique key and some attributes and constraints about the field.

Localized fields are idependant of the concept of Segment.

Responses

  • 200 application/json

    Successfully returned available localized fields

    Hide response attributes Show response attributes object
    • status string
    • result object
      Hide result attribute Show result attribute
      • localized_fields array[object]
        Hide localized_fields attributes Show localized_fields attributes object
        • key String

          The unique key to identify this localized field

        • trads object

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

          Hide trads attributes Show trads attributes
GET /localized-fields 
curl \
 -X GET https://api.ppe-analytics.com/api/v1/localized-fields \
 -H "PPEApiKey: $API_KEY"
Response examples (200) 
{
  "status": "OK",
  "result": {
    "localized_fields": [
      {
        "key": "long-label",
        "trads": {
          "en": "Long label",
          "fr": "Libellé long"
        }
      },
      {
        "key": "acme--catchphrase",
        "trads": {
          "en": "Catchphrase",
          "fr": "Phrase d'accroche"
        }
      },
      {
        "key": "acme--fabdis-desc-32",
        "trads": {
          "en": "FabDis description 32 chars",
          "fr": "Description FabDis 32 caractères"
        }
      }
    ]
  }
}