EnrichmentInsightSetups

Enrichment insight setups are used to define insights that are continuously calculated for products, variants or categories in the system. The Enrichment insight setup defines which data is required for an entity to be considered 100% fulfilled for the insight setup in question.

Get all Enrichment Insights

get

#Available from v.3.5.0

Authorizations
Responses
200
OK
get
GET /v1/enrichmentinsightsetups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "EntityType": 10,
    "Alias": "text",
    "Label": "text",
    "Setup": [
      {
        "ConfigurationUid": "123e4567-e89b-12d3-a456-426614174000",
        "CategoryId": 1,
        "RequiredData": [
          {
            "Type": "text",
            "DataReference": "text"
          }
        ]
      }
    ]
  }
]

Create a new Enrichment Insight

post

#Available from v.3.5.0

Authorizations
Body

Model defining setup of an enrichment insight

Uidstring · uuidOptional

Unique id of enrichment insight setup

EntityTypeinteger · enumOptional

Enum representing each supported entity type in enrichment insights engine

Possible values:
Aliasstring | nullableOptional

Unique alias of this insight setup

Labelstring | nullableOptional

Presented name of this enrichment insight setup

Responses
200
OK
post
POST /v1/enrichmentinsightsetups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 233

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "EntityType": 10,
  "Alias": "text",
  "Label": "text",
  "Setup": [
    {
      "ConfigurationUid": "123e4567-e89b-12d3-a456-426614174000",
      "CategoryId": 1,
      "RequiredData": [
        {
          "Type": "text",
          "DataReference": "text"
        }
      ]
    }
  ]
}
200

OK

No content

Update a Enrichment Insight

put

#Available from v.3.5.0

Authorizations
Body

Model defining setup of an enrichment insight

Uidstring · uuidOptional

Unique id of enrichment insight setup

EntityTypeinteger · enumOptional

Enum representing each supported entity type in enrichment insights engine

Possible values:
Aliasstring | nullableOptional

Unique alias of this insight setup

Labelstring | nullableOptional

Presented name of this enrichment insight setup

Responses
200
OK
put
PUT /v1/enrichmentinsightsetups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 233

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "EntityType": 10,
  "Alias": "text",
  "Label": "text",
  "Setup": [
    {
      "ConfigurationUid": "123e4567-e89b-12d3-a456-426614174000",
      "CategoryId": 1,
      "RequiredData": [
        {
          "Type": "text",
          "DataReference": "text"
        }
      ]
    }
  ]
}
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "EntityType": 10,
  "Alias": "text",
  "Label": "text",
  "Setup": [
    {
      "ConfigurationUid": "123e4567-e89b-12d3-a456-426614174000",
      "CategoryId": 1,
      "RequiredData": [
        {
          "Type": "text",
          "DataReference": "text"
        }
      ]
    }
  ]
}

Delete a Enrichment Insight

delete

#Available from v.3.5.0

Authorizations
Query parameters
uidstring · uuidOptional

Uid of Enrichment Insight to delete

Responses
200
OK
delete
DELETE /v1/enrichmentinsightsetups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get a specific Enrichment Insight

get

#Available from v.3.5.0

Authorizations
Path parameters
uidstring · uuidRequired

Unique id of Enrichment Insight

Responses
200
OK
get
GET /v1/enrichmentinsightsetups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "EntityType": 10,
  "Alias": "text",
  "Label": "text",
  "Setup": [
    {
      "ConfigurationUid": "123e4567-e89b-12d3-a456-426614174000",
      "CategoryId": 1,
      "RequiredData": [
        {
          "Type": "text",
          "DataReference": "text"
        }
      ]
    }
  ]
}

Get available data references for a specific entity type

get

#Available from v.3.5.0

Authorizations
Path parameters
entityTypeinteger · enumRequired

Type of entity (Category, Product or Variant)

Possible values:
Query parameters
configurationUidstring · uuidOptional

Uid of configuration (product structure or catalogue) to get available data references for

categoryIdinteger · int32Optional

CategoryId to get data references for

Responses
200
OK
get
GET /v1/enrichmentinsightsetups/{entityType}/availabledatareferences HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Name": "text",
    "Type": "text",
    "DataReference": "text"
  }
]
PreviousExportsNextGlobalLists