Retrieving the list of existing goals for an entity

It is possible to retrieve the list of existing goals for an entity, with their characteristics. This allows you to obtain the state of your goals without using the ACTITO interface.

To do so, you will need to use the operation GET/entity/{e}/goals

The only mandatory parameter is the name or the id of the entity to which the goals belongs. In addition, you can specify query parameters to filter your results:

• Type filter: you can choose to only retrieve transaction goals or web page visit goals

• Status filter: you can choose to only retrieve active, inactive or in definition goals

You will obtain the list of existing goals for the entity, with details pertaining to the following elements:

• The goal technical id: this is an auto-generated number

• The goal name: this is the display name that you chose at the goal creation. It can be modified in the ACTITO interface

• The id of the profile table targeted by the goal

• The id of the entity to which the goal belongs

• The goal type: whether it is a transaction goal or a web page visit goal

• The goal status: whether the goal is active, inactive or still in definition

• The goal creation moment and its latest update moment

Example of a request and its response: GET/entity/{e}/goals.docx

Retrieving the definition of a goal

You can retrieve the characteristics of a specific goal through the operation GET/entity/{e}/goals/{g}

You will need to provide the following parameters:

• The name or the id of the entity to which the goal belongs

• The auto-generated id or the display name of the goal

You will obtain a response with the same elements and the same structure as the previous operation.

Retrieving the ActId of a profile

The concept of ActId refers to the unique id which is used to link a given profile to a goal. It is stored on a cookie dropped on the browser of the user. Its interaction with the script inserted on your web pages is necessary for goals to function properly.

This cookie is usually set through the means of an ACTITO e-mail. However, in order to offer connectivity between ACTITO and the various partner platforms or systems specific to your business, you can create this cookie yourself and drop it through any mean relevant to your activity (for example, after connecting to a customer area). This alternative will notably allow you to record goals for profiles who never clicked in an ACTITO e-mail.

To create this cookie, you will need to retrieve the ActiId of each profile. This is possible through the operation GET/entity/{e}/goal/table/{t}/profile{p}

The following parameters are required for this operation:

• e = the entity in which the table belongs

• t = the name of the profile table

• p = the ID of the profile (profileId) or a key attribute (for instance, the e-mail address). In the second case, you need to use format 'keyAttribute=value' (for example, emailAddress=mailtest@actito.com).

Example of a request and its response:

The response to this request is the ActId of the selected profile.

Creating a transaction goal interaction

It is possible to create a transaction goal interaction for a given profile through the operation POST/entity/{e}/goals/{g}/profile/{p}/transaction

This allows you to record a transaction goal whatever might be the source that led to this transaction.

To create a transaction goal interaction, you will need to provided the following parameters:

• The entity to which the goal belongs

• The goal: you can either use the name of the goal you chose when creating or editing the goal, or its auto-generated technical id

• The profile who reached the goal: you will need to provide its "profileId"

• "transactionGoalInteraction": this is a JSON code containing the additional parameters specific to a transaction goal. Just as for the script that can inserted on your website, these parameters are:

  • amountCent: The transaction amount, in cents. In the ACTITO interface, this amount will be converted into €.

  • businessId: The key ID of the transaction.

  • comment: A comment associated with the transaction. You can choose what you want this field to display.

  • source: The source of the transaction. When creating the interaction through API, you can parameter this field to state the origin of the transaction.

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

The response to this request will be the interaction id.