Why use enrichment?
It is possible to create three types of enrichment at the moment:
- Users: This allows you to add information from your CRM such as age, gender, user category etc..
- Catalog: For Sales Insights users you can enrich your product properties such as categories.
- Audio and Video Content : For AV Insights users you can enrich your audio and video content properties such as author, title, season etc.
What are the advantages of enrichment over tagging?
- Flexibility, no need to update tagging to add new properties
- Lighter marking with only one ID to be filled in
- Discretion, there are some properties you do not want to expose to your internet users (for example the margin on your products)
- Day in progress, the marking only allows to add information on the next events received, the enrichment will allow to add information on data already received.
How do I activate enrichment?
In order to benefit from this feature, you should ask our support center to activate it on your organisation.
How to retrieve the analyses?
At the moment, you can only find this information in Data Query 3.
What type is property is usable?
The key used for the enrichment shouldn’t contain double quotes.
Type |
Additionnal information |
Example |
String |
Case sensitive with 255 characters maximum (without double quotes) |
MyCategory |
Numeric |
- |
145213 |
Decimal |
Separator must be a dot |
13.10 |
Boolean |
Two possible values: true/false (lowercase mandatory) can also be empty |
true |
Date (ISO 8601 Notation) |
- |
2013-02-08 2013-02-08 09 # An hour time part separated by a space 2013-02-08 09:30 # An hour and minute time part 2013-02-08 09:30:26 # An hour, minute, and second time part 2013-02-08 09:30:26.123 # An hour, minute, second, and millisecond time part |
What happens when the tag and import have a different value?
An enriched value systematically overloads the collected value.
Unless the enriched value is empty, then we will keep the value in the tag.
How array properties are displayed in the interface?
The array properties are returned as a string in our interfaces and therefore as a single value per combination. You can use the filters in the table to focus on a value and not a combination.
Import management
Via CSV file
When using a CSV file it is important to follow several rules:
- The separator to use is the comma
- To escape the values: Work in progress
Via API
To use the API in order to mange imports, it is important to follow several rules:
- Mandatory POST method
- Presence of the header x-api-key
- The body of the JSON should be correctly formatted
- Checks on the call parameters are made:
- {codeOrga} : present and in capital letters
- {importId} : present
You can use our help centre to retrieve an API key allowing you to use the API: https://helpcentre.atinternet-solutions.com/hc/fr/articles/360008912079-Sujets-li%C3%A9s-aux-droits-d-acc%C3%A8s#LesAPIkeyspourlesconnexionsexternes
Once your API key has been retrieved, you can go to the enrichment interface, select the enrichment of your choice and access the Import Data tab. You can find in there the API to use with an example.
Update of imports
Once your first import is done, you will be able to update it whenever you want. During this operation you will be able to add new lines but also modify the information present in the import. To understand the impacts, let’s take an example.
We are using the following import:
ID |
Nation |
Region |
Gender |
Age range |
1 |
England |
South |
Male |
25-39 |
2 |
England |
South |
Female |
65-70 |
3 |
England |
London |
Female |
65-70 |
You import the following file:
ID |
Nation |
Region |
Gender |
Age range |
1 |
|
|
|
|
3 |
England |
North |
|
|
4 |
France |
Paris |
Female |
40-49 |
We will merge these two files with the following changes:
ID |
Nation |
Region |
Gender |
Age range |
Commentaires |
1 |
|
|
|
|
Empty lined |
2 |
England |
South |
Female |
65-70 |
No change |
3 |
England |
|
|
|
Region updated |
4 |
France |
Paris |
Female |
40-49 |
Added line |
In our example, the data that will then be ennriched will be based on this last table.
How to clear a value from a property
Via API
IF the property is not present in the API call in <DATA>, the value stored in our catalog isn’t modified.
- If it was empty, it remains empty
- If itw as completed, the recorded value is not changed.
Example
If we don’t want to specify the email however defined in the import structure
{
"user_id": "12345",
"age": 35
}
To force the deletion of a value stored in the catalog, you must specify « null »
Example
{
"user_id": "12345",
"email": null,
"age": 35
}
Via CSV
The line imported into the CSV will be used. If a value is empty in the CSV and in our database we had a value for this cell, it will clear the value and make it empty.
Example
In the import we have
user_id |
|
age |
12345 |
myEmail@mail.com |
35 |
We import the following file
user_id,email,age
12345,,35
After the update we will have
user_id |
|
age |
12345 |
|
35 |
How to proceed when changing the import configuration
Add a property
To add a property to enrich, it is necessary to check with your usual internet AT contacts. In the near future, an interface will be made available to manage these properties yourself. When you change mapping, it will be different depending if you use API or CSV.
Via API
Deleting a property
If you delete one or more properties, it will continue to work correctly, the removed properties will just be ignored.
Adding a property
It will be ignored until you update your API call
Via CSV
Whatever the action add/delete column, it is imperative to modify the structure of the CSV so that the headers respect the structure defined in the import.
To retrieve the structure you can go to the enrichment interface, select the enrichment of your choice and then access the Import Data tab. You can find the structure by clicking on sFTP or Manual upload, then clicking on the Download csv header button