Documentation Skalin

Collecte des fonctionnalités utilisées

Collecte des fonctionnalités utilisées

Savoir qu'elles sont les fonctionnalités utilisées par un client sur votre plateforme permet je connaitre son niveau d'implication ou son autonomie. Afin de permet la collecte de cette information, il faut appeler les serveurs Skalin.

Le code ci-dessous permet de collecter l'usage d'une fonctionnalité de votre plateforme :

curl -G --location \
--request POST 'https://collect.skalin.io/hit' \
--data-urlencode 'rec=1' \
--data-urlencode 'action=ev' \
--data-urlencode 'client_id={{ClientId}}' \
--data-urlencode 'customer_id={{CustomerId}}' \
--data-urlencode 'event_id={{EventId}}' \
--data-urlencode 'visitor_id={{VisitorId}}' \
--data-urlencode 'visit_id={{VisitId}}' \
--data-urlencode 'localtime={{LocalTime}}' \
--data-urlencode 'identity={"email":"{{UserEmail}}"}' \
--data-urlencode 'event={"name":"{{FeatureName}}","event_name":"feature"}' \
--data-urlencode 'url={{Url}}' \
--data-urlencode 'cip={{Cip}}'
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Avec NodeJS et la librairie axios (opens new window)

axios({
  method: 'POST',
  url: 'https://collect.skalin.io/hit',
  headers: {
    "Cache-Control": "no-cache",
  },
  params: {
    rec: 1,
    action: 'ev',
    client_id: '{{ClientId}}',
    customer_id: '{{CustomerId}}',
    event_id: '{{EventId}}',
    visitor_id: '{{VisitorId}}',
    visit_id: '{{VisitId}}',
    localtime: '{{LocalTime}}',
    identity: {"email":"{{UserEmail}}"}, // {"id":"{{UserId}}"}
    event: {"name":"{{FeatureName}}","event_name":"feature"},
    url: '{{Url}}',
    cip: '{{Cip}}',
    ts: '{{ts}}'
  }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
ClientId

votre identifiant client qui vous a été fourni par Skalin ou est disponible dans la section Paramétrage > Général

CustomerId (facultatif) identifiant du client ou nom de domaine du client (le CustomerId n’est utile que si un même contact peut de connecter à plusieurs entités avec le même identifiant)
EventId (facultatif car auto-généré) identifiant unique de l'événement de 16 caractères. Permet de gérer la dé-duplication (Le dernier transmit sera conservé).
VisitorId identifiant unique du contact / visiteur. uid de 16 caractères
VisitId identifiant unique de la visite ou de la session. uid de 16 caractères (permet de calculer le nombre de visites. Si VisitId n’est pas rempli ou différent à chaque appel, chaque appel sera comptabilisé comme une nouvelle visite).
LocalTime (facultatif) heure:minutes:secondes dans la timezone de l’utilisateur (`08:00:05`)
UserEmail Email de l'utilisateur connecté déjà référencé dans Skalin
FeatureName Nom de la fonctionnalité utilisée
Url (facultatif) Url de la fonctionnalité sur votre plateforme
Cip (facultatif) Ip de l'utilisateur
ts (facultatif) timespan de l'évènement au format YYYY-MM-DDTHH:mm:ss (Si non défini, le timespan est initialisé avec l'heure du serveur)

Info

CustomerId correspond à la propriété refId de l'API (champ Customer ID de l'interface d'édition du client)

Contributeurs: Julien