# EnrichmentInsightSetups
#Available from v.3.5.0 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 /enrichmentinsightsetups Get all Enrichment Insights
#Available from v.3.5.0
[
{
"Uid": "928540d4-631c-4a8e-be40-5716e7f8aeef",
"EntityType": 20,
"Alias": "WebReady",
"Label": "Ready for web",
"Setup": [
{
"ConfigurationUid": "48e558eb-e90a-4b6b-b1eb-033bad16dd4b",
"RequiredData": [
{
"Type": "AttributeInsightsDataReference",
"DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
},
{
"Type": "AttributeInsightsDataReference",
"DataReference": "d83b20ce-f2ef-4fe1-adff-51867de72f71_NA_NA"
}
]
}
]
},
{
"Uid": "951ca2ba-ea81-42b2-a3b3-1992a685956f",
"EntityType": 20,
"Alias": "BasicEnrichment",
"Label": "Basic sales enrichment",
"Setup": [
{
"ConfigurationUid": "6c57b23d-587c-4970-b0e1-2f5bfbd5b4d7",
"RequiredData": [
{
"Type": "AttributeInsightsDataReference",
"DataReference": "3e5218b1-4808-4d61-b4e0-f4a1b954d5c8_9_NA"
}
]
}
]
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of enrichment insight setup |
| EntityType | string |
Entity type this insight is to be calculated for |
| Alias | string |
Unique alias of this insight setup |
| Label | string |
Presented name of this enrichment insight setup |
| Setup | array : ConfigurationInsightSetup |
Setup of required fields for each configuration available to this insight setup (One for each product structure or each catalogue depnding on the entity type) |
| Property name | Data type | Description |
|---|---|---|
| ConfigurationUid | string |
Uid of configuration these required data accounts for (if entity type of insights setup is category, this will be the uid of a catalogue. For variants and products this should hold the uid of a product structure) |
| CategoryId | integer |
Id of selected category which is chosen for the insight |
| RequiredData | array : InsightDataReference |
List of data references that are required for this insight to be 100% for entities using the configuration in question |
| Property name | Data type | Description |
|---|---|---|
| Type | string |
Type of data reference |
| DataReference | string |
The data reference itself |
PUT /enrichmentinsightsetups Update a Enrichment Insight
#Available from v.3.5.0
{
"Uid": "c3f07028-fd53-4fd3-9e51-5d19c30dd8f5",
"EntityType": 20,
"Alias": "WebReady",
"Label": "Ready for web",
"Setup": [
{
"ConfigurationUid": "48e558eb-e90a-4b6b-b1eb-033bad16dd4b",
"RequiredData": [
{
"Type": "AttributeInsightsDataReference",
"DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
},
{
"Type": "AttributeInsightsDataReference",
"DataReference": "d83b20ce-f2ef-4fe1-adff-51867de72f71_NA_NA"
}
]
}
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| setup | body | object : EnrichmentInsightSetup |
Enrichment Insight to update |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of enrichment insight setup |
| EntityType | string |
Entity type this insight is to be calculated for |
| Alias | string |
Unique alias of this insight setup |
| Label | string |
Presented name of this enrichment insight setup |
| Setup | array : ConfigurationInsightSetup |
Setup of required fields for each configuration available to this insight setup (One for each product structure or each catalogue depnding on the entity type) |
| Property name | Data type | Description |
|---|---|---|
| ConfigurationUid | string |
Uid of configuration these required data accounts for (if entity type of insights setup is category, this will be the uid of a catalogue. For variants and products this should hold the uid of a product structure) |
| CategoryId | integer |
Id of selected category which is chosen for the insight |
| RequiredData | array : InsightDataReference |
List of data references that are required for this insight to be 100% for entities using the configuration in question |
| Property name | Data type | Description |
|---|---|---|
| Type | string |
Type of data reference |
| DataReference | string |
The data reference itself |
Response status OK (200)
POST /enrichmentinsightsetups Create a new Enrichment Insight
#Available from v.3.5.0
{
"Uid": "ffd37b0d-423e-421a-9122-bc518941d85f",
"EntityType": 20,
"Alias": "WebReady",
"Label": "Ready for web",
"Setup": [
{
"ConfigurationUid": "48e558eb-e90a-4b6b-b1eb-033bad16dd4b",
"RequiredData": [
{
"Type": "AttributeInsightsDataReference",
"DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
},
{
"Type": "AttributeInsightsDataReference",
"DataReference": "d83b20ce-f2ef-4fe1-adff-51867de72f71_NA_NA"
}
]
}
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| setup | body | object : EnrichmentInsightSetup |
Enrichment Insight to create |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of enrichment insight setup |
| EntityType | string |
Entity type this insight is to be calculated for |
| Alias | string |
Unique alias of this insight setup |
| Label | string |
Presented name of this enrichment insight setup |
| Setup | array : ConfigurationInsightSetup |
Setup of required fields for each configuration available to this insight setup (One for each product structure or each catalogue depnding on the entity type) |
| Property name | Data type | Description |
|---|---|---|
| ConfigurationUid | string |
Uid of configuration these required data accounts for (if entity type of insights setup is category, this will be the uid of a catalogue. For variants and products this should hold the uid of a product structure) |
| CategoryId | integer |
Id of selected category which is chosen for the insight |
| RequiredData | array : InsightDataReference |
List of data references that are required for this insight to be 100% for entities using the configuration in question |
| Property name | Data type | Description |
|---|---|---|
| Type | string |
Type of data reference |
| DataReference | string |
The data reference itself |
Response status OK (200)
DELETE /enrichmentinsightsetups Delete a Enrichment Insight
#Available from v.3.5.0
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | query | string |
Uid of Enrichment Insight to delete |
Response status OK (200)
GET /enrichmentinsightsetups/{entityType}/availabledatareferences Get available data references for a specific entity type
#Available from v.3.5.0
[
{
"Name": "Name (da-DK)",
"Type": "AttributeInsightsDataReference",
"DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
},
{
"Name": "Color",
"Type": "AttributeInsightsDataReference",
"DataReference": "d83b20ce-f2ef-4fe1-adff-51867de72f71_NA_NA"
},
{
"Name": "Brand",
"Type": "AttributeInsightsDataReference",
"DataReference": "ac6cbf42-fa4f-4f40-a6cf-a7a81af74815_NA_NA"
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| entityType | path | string |
Type of entity (Category, Product or Variant) |
| configurationUid | query | string |
Uid of configuration (product structure or catalogue) to get available data references for |
| categoryId | query | integer |
CategoryId to get data references for |
Response status OK (200)
GET /enrichmentinsightsetups/{uid} Get a specific Enrichment Insight
#Available from v.3.5.0
{
"Uid": "9e7ecd44-d674-4a5d-8080-13b777f89888",
"EntityType": 20,
"Alias": "WebReady",
"Label": "Ready for web",
"Setup": [
{
"ConfigurationUid": "48e558eb-e90a-4b6b-b1eb-033bad16dd4b",
"RequiredData": [
{
"Type": "AttributeInsightsDataReference",
"DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
},
{
"Type": "AttributeInsightsDataReference",
"DataReference": "d83b20ce-f2ef-4fe1-adff-51867de72f71_NA_NA"
}
]
}
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unique id of Enrichment Insight |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of enrichment insight setup |
| EntityType | string |
Entity type this insight is to be calculated for |
| Alias | string |
Unique alias of this insight setup |
| Label | string |
Presented name of this enrichment insight setup |
| Setup | array : ConfigurationInsightSetup |
Setup of required fields for each configuration available to this insight setup (One for each product structure or each catalogue depnding on the entity type) |
| Property name | Data type | Description |
|---|---|---|
| ConfigurationUid | string |
Uid of configuration these required data accounts for (if entity type of insights setup is category, this will be the uid of a catalogue. For variants and products this should hold the uid of a product structure) |
| CategoryId | integer |
Id of selected category which is chosen for the insight |
| RequiredData | array : InsightDataReference |
List of data references that are required for this insight to be 100% for entities using the configuration in question |
| Property name | Data type | Description |
|---|---|---|
| Type | string |
Type of data reference |
| DataReference | string |
The data reference itself |