Attributes

Profile attributes amount to the main data of profiles. Each attribute is defined by parameters that characterize its nature and the way it is used. For additional information about attributes, we invite you to read the chapter explaining how to 'Add an attribute to the profile table'.

The body of the answer will show the attributes one after the other, along with the detail of its parameters. These are characterized as follows :

• "mandatory": This parameter shows whether or not the attribute is mandatory, with a 'true/false' format.

• "multiValue": This parameter shows whether the attribute can have several values, with a 'true/false' format. In such a case, the values for a specific profile will be presented as follows: ["a", "b"].

• "unicity" states whether the attributes is unique or not. It can be :

  • UNIQUE_FOR_ALL_ELEMENTS: The value can be present for only one profile within the database. This will be the case for attributes used as 'keys' (for example: 'clientId' or 'emailAddress')

  • NOT_UNIQUE: The value of this attribute can be identical for several profiles (for example: a first name or a country)

  • UNIQUE_BY_ELEMENT: This is only applied for multi-values attributes. This implies that each value can only appear one for each profile.

• "valueType": This parameter shows the expected format of the attribute (for example: integer, boolean, phone number,...)

• "possibleValues": This parameter shows which values are accepted by the attribute. Values not included in this restriction will be rejected. This parameter is optional.

• "comment": This is the description of the attribute. It is optional.

Subscriptions

Subscriptions are the representation of the 'opt-ins' of each profile. For additional information about subscriptions, we invite you to read the chapter on 'Adding a subscription to the profile table'.

In the response body of the webservice request, they are named 'subscription' and their components are:

• "name": This parameter states the name of the attribute

• "id": This is the auto-generated technical id of the attribute. It is specific to each database.

Segmentations

Segmentations allow you to group profiles based on common characteristics. For additional information about segmentations, we invite you to read the chapter on 'Adding a segmentation to a profile table'.

In the response body of the webservice request, they are named 'segmentation' and their characteristics are:

• "segmentation": This is the technical name of the segmentation. It is auto-generated at the creation of the segmentation within the interface, on the basis of your chosen display name but without spaces and special characters. Please note that, although it is possible to edit the display name of a segmentation in the interface, the technical name cannot be modified and will always remain the original one.

• "exclusive": This parameter shows whether the segmentation is exclusive, with a 'true/false' format. An exclusive segmentation differs from a simple segmentation in that a sub-category of segments exists.

• "categories":

  • In the case of exclusive segmentations, this shows the various segments to which a profile can belong.

  • For simple segmentations, the only category is "Member", which states whether or not a profile belongs to the segmentation.

Obtaining the characteristics of a given profile

After getting to know the structure of the profile table, you have the necessary elements to correctly parameter profile import methods.

However, it might prove useful to obtain information on profiles already existing in your database. This is will give you a practical example of the information expected for profile creation calls, especially when it comes to the characteristics of individual attributes. Afterwards, this operation will allow you to call the data of a profile, for example if the they want to consult their contact details in their client area.

You can retrieve details about a specific profile through the operation GET/entity/{e}/table/{t}/profile/{p}

To do so, you will need to indicate the following parameters:

• The entity

• The profile table

• The profile whose data you want to search: you will have to either use the technical ID of a profile (id generated by ACTITO at the creation of the profile, named "profileId") or any attribute defined as a unique key (for example: the client number, the e-mail address,...). In the second case, you need to use format 'keyAttribute=value' (for example, emailAddress=mailtest@actito.com). To know which attribute is used as a key, go to the 'Reaching a Profile File'.

Example of a request and its response for this operation: (Download this example)

Please note that some technical attributes are automatically given in the answer. These attributes cannot be modified. They are:

• "profileId": The auto-generated technical id, which you could use as key

• "creationMoment": The creation time and date

• "updateMoment": The time and date of the latest update

Only subscriptions and segmentations currently associated to the profile will be displayed. Any segmentation or subscription to which the profile does not belong will not appear.

Using query parameters

If you do not know the 'profileId' or any other key attribute of a given profile, or if you want to obtain a list of profiles based on specific criterion, it is possible to use query parameters through the operation GET/entity/{e}/table/{t}/profile

These query parameters are:

• "search": Search criterion that can be made of multiple criteria separated by ';'. This criterion is made of the technical name of the attribute, followed by the '=' operator and a value

• "dateFilter": Search criterion based on a date that can be made of multiple criteria separated by ';'. This criterion must be based on the 'creationMoment' or 'updateMoment' attributes, followed by an operator ('>', '<', '>=' or '<=') then by a date value.

• "number": This parameter limits the amount of results displayed (200 is the default and maximum value).

Should you wish to retrieve the details of any profile, in order to get to know the structure of a profile file, you can set the "number" filter to 1.

Obtaining profile interactions

It is possible to retrieve the interactions of a profile through the operation GET/entity/{e}/table{t}/profile{p}/interactions

In such a case, the entity, the profile table and the profile id must be used as parameters. In addition, the following criteria are available:

• "dateFilter": This is a date criterion based on the 'creationMoment' attribute

• "typeFilter": This is a filter based on the interaction type. Leave this field empty to include all interactions. Only one kind of interaction can be targeted at once. If you want to target interactions linked to Custom Tables, you need to choose the 'UserDefined' filter.

• "includeTest": This filter allows you to include and exclude test interactions.

Example of a request and its response for this operation: (Download this example)

Obtaining the subscriptions of a profile

It is possible to retrieve the list of subscriptions to which a profile subscribed through the operation GET/entity{e}/table{t}/profile{p}/subscription

In such a case, the entity, the profile table and the profile id must be used as parameters

Example of a request and its response: (Download this example)

Obtaining the segmentation of a profile

It is possible to retrieve the list of segmentations to which a profile belongs through the operation GET/entity{e}/table{t}/profile{p}/segmentation

In such a case, the entity, the profile table and the profile id must be used as parameters

Example of a request and its response: (Download this example)

Creating and updating a single profile

Several operations exist for the creation and the update of profiles one by one. One advantage of this course of action is that there are pre-parametered operations aimed at updating specific elements of a profile table, such as subscriptions and segmentations.

For a detailed explanation regarding these operations, we invite you to read the 'Creating or Updating a Single Profile' page.

Creating and updating profiles in bulk

Mass imports are based on data files. Should some data entries fall into error during the import attempt, you will obtain their details in order to let you rectify this problem.

To learn how this method works, please consult the 'Creating or Updating Profiles in Bulk' page.