Aller au contenu principal

Webservices liés aux goals

Les "Goals" Actito permettent d'identifier les personnes qui visitent votre site web et de récupérer des informations concernant leur comportement sur votre site : les visites de page ou les confirmations de commande.

Lorsqu'un profil atteint un goal, Actito enregistre une interaction entre le goal et ce profil. En plus de servir de statistiques, les goals peuvent être utilisés pour cibler des profils, les ajouter à un segment ou déclencher des communications.

La création d'un goal n'est pas possible par API. Elle doit obligatoirement se faire via l'interface Actito. De plus, une manipulation est nécessaire sur votre site web, sur les pages visées par le goal. Pour plus d'information à ce sujet, nous vous invitons à vous référer au chapitre consacré aux "Goals"

En revanche, les webservices liés aux goals vous permettront de :

Enregistrer des goals via un système externe

Le moyen principal d'enregistrer des goals est dû à l'interaction entre le script inséré sur vos pages web et le cookie généré quand un profil clique sur un lien présent dans un e-mail Actito pour lequel le suivi des goals a été activé.

Ceci impliquerait que les goals ne puissent être atteints que par des profils ayant déjà reçu et cliqué dans un e-mail Actito. Grâce à la connectivité accrue permise par les webservices Actito, vous avez cependant la possibilité d'enregistrer des interactions de goals pour un profil qui auraient atteint ce goal par un système externe.

Vous avez pour cela deux possibilités :

  • Générer vous-même le cookie en récupérant l'actId d'un profil
  • Créer une interaction de goal transactionnel via API

Récupérer l'actId d'un profil

Le concept d'actId désigne l'identifiant unique qui va permettre de faire le lien entre un profil donné et un goal. Il est stocké sur un cookie déposé sur le navigateur de l'utilisateur et c'est son interaction avec le script inséré sur vos pages web qui permettront le bon fonctionnement des goals.

Ce cookie est habituellement transmis par le biais d'un e-mail Actito. Cependant, dans un souci de connectivité entre Actito et les différentes plateformes partenaires ou les systèmes qui vous sont propres, rien ne vous empêche de créer vous-même ce cookie et de la déposer par un moyen le plus approprié selon votre activité (par exemple, lors de la connexion à un espace client). Cette alternative vous permettra notamment d'enregistrer des goals pour des profils qui n'ont encore jamais cliqué dans un e-mail Actito.

Pour créer ce cookie, il est nécessaire de pouvoir récupérer l'identifiant actId pour chaque profil. Ceci est possible grâce à l'opération GET/entity/{e}/goal/table/{t}/profile/{p}

La réponse à cette requête sera l'actId du profil visé. Il s'agit d'une chaîne de caractères correspondant à 1 profil dans 1 DB, qui peut être utilisé pour générer le cookie de goal de votre côté.

Créer une interaction de goal transactionnel

Il est possible de créer une interaction de goal transactionnel pour un profil donné via l'opération POST/entity/{e}/goals/{g}/profile/{p}/transaction

Ceci vous permet d'enregistrer un goal transactionnel quelle que soit la source ayant permis la génération de cette transaction.

Les paramètres à renseigner dans le body de l'appel pour créer une interaction de goal transactionnel sont

  • amountCent : Le montant de la transaction en cents. Dans l'interface Actito, ce montant sera converti en €.
  • businessId : La clé d'identification de la transaction.
  • comment : Un commentaire accompagnant la transaction. Vous pouvez définir ce que vous voulez afficher dans ce champ.
  • source : La source de la transaction. Dans le cas d'une création par API, ce champ pourra être paramétré pour indiquer la provenance de la transaction.

Créer une interaction de goal de visite de site web

Il est également possible de créer une interaction de goal de visite de site web, pour suivre les profils qui ont visité une page de votre site web.

C'est réalisable grâce à l'opération POST/entity/{e}/goals/{g}/profile/{p}/websitevisit

Dans le body JSON, le paramètre matchedUrl correspond à l'URL de la page visitée par le profil. Cela doit être une URL suivie dans la définition du goal dans Actito.