Skip to main content

Get concepts

GET 
/platform/v1/:project-id/concepts

This endpoint retrieves all concepts in your ontology (i.e., categories, attributes, and text values).

When requesting concepts, you can filter by id-names and/or the following concept types:

  • CATEGORY
  • NUMERIC_ATTRIBUTE
  • TEXT_ATTRIBUTE
  • BOOLEAN_ATTRIBUTE
  • UNTYPED_ATTRIBUTE
  • DATE_ATTRIBUTE

Request​

Responses​

{
  "concepts": [
    {
      "idName": "ROOT/Gift",
      "type": "CATEGORY",
      "localization": {
        "en": {
          "name": "Gift",
          "synonyms": [
            "gifts"
          ],
          "extractionRules": [
            {
              "type": "IS",
              "text": [
                {
                  "type": "MATCH",
                  "text": "root gift"
                }
              ]
            }
          ]
        }
      },
      "children": [
        {
          "idName": "ROOT/Gift/Gifts up to 200 euros",
          "type": "CATEGORY",
          "localization": {
            "en": {
              "name": "Gifts up to 200 euros",
              "extractionRules": [
                {
                  "type": "IS",
                  "text": [
                    {
                      "type": "MATCH",
                      "text": "root gift gifts up to 200 euros"
                    }
                  ]
                }
              ]
            }
          },
          "children": [
            {
              "idName": "ROOT/Gift/Gifts up to 200 euros/Games",
              "type": "CATEGORY",
              "localization": {
                "en": {
                  "name": "Games",
                  "synonyms": [
                    "game"
                  ],
                  "extractionRules": [
                    {
                      "type": "IS",
                      "text": [
                        {
                          "type": "MATCH",
                          "text": "root gift gifts up to 200 euros games"
                        }
                      ]
                    }
                  ]
                }
              },
              "structuredViewData": {
                "url": {
                  "link": ""
                }
              }
            }
          ]
        }
      ]
    },
    {
      "idName": "Bestseller",
      "type": "BOOLEAN_ATTRIBUTE",
      "localization": {
        "en": {
          "name": "Bestseller",
          "trueState": "yes",
          "falseState": "no",
          "extractionRules": [
            {
              "type": "IS",
              "text": [
                {
                  "type": "MATCH",
                  "text": "bestseller"
                }
              ]
            }
          ]
        }
      },
      "structuredViewData": {}
    },
    {
      "idName": "BRAND",
      "type": "TEXT_ATTRIBUTE",
      "localization": {
        "en": {
          "name": "Brand",
          "extractionRules": [
            {
              "type": "IS",
              "text": [
                {
                  "type": "MATCH",
                  "text": "brand"
                }
              ]
            }
          ]
        }
      },
      "children": [
        {
          "idName": "BRAND_#_BRANDA",
          "type": "TEXT_VALUE",
          "localization": {
            "en": {
              "name": "BrandA",
              "extractionRules": [
                {
                  "type": "IS",
                  "text": [
                    {
                      "type": "MATCH",
                      "text": "branda"
                    }
                  ]
                }
              ]
            }
          },
          "structuredViewData": {}
        },
        {
          "idName": "BRAND_#_BRANDB",
          "type": "TEXT_VALUE",
          "localization": {
            "en": {
              "name": "BrandB",
              "extractionRules": [
                {
                  "type": "IS",
                  "text": [
                    {
                      "type": "MATCH",
                      "text": "brandb"
                    }
                  ]
                }
              ]
            }
          },
          "structuredViewData": {}
        }
      ]
    },
    {
      "idName": "DESCRIPTION",
      "type": "UNTYPED_ATTRIBUTE",
      "localization": {
        "en": {
          "name": "Description",
          "extractionRules": [
            {
              "type": "IS",
              "text": [
                {
                  "type": "MATCH",
                  "text": "description"
                }
              ]
            }
          ]
        }
      },
      "structuredViewData": {}
    },
    {
      "idName": "PRICE",
      "type": "NUMERIC_ATTRIBUTE",
      "localization": {
        "en": {
          "name": "Price",
          "unitName": "USD",
          "extractionRules": [
            {
              "type": "IS",
              "text": [
                {
                  "type": "MATCH",
                  "text": "price"
                }
              ]
            }
          ]
        }
      },
      "structuredViewData": {}
    }
  ]
}
Response Headers
    content-type:application-json