(obsolète) Source HTTP tracking API 1.0

Deprecated

Vous consultez l’ancienne version de l’API (version 1.0) Commanders Act mettra fin au support et à la maintenance de la source HTTP tracking API 1.0 le 31 août 2023. Cette API sera entièrement obsolète en décembre 2023. Après cette date, le format actuel ne sera plus pris en charge et toute requête l’utilisant pourra générer une erreur.

Nous vous encourageons à commencer à utiliser le nouveau format de payload dès que possible afin d’assurer une transition en douceur. Le nouveau format est décrit ici. Veuillez vous référer à notre documentation pour plus d’informations sur la manière d’utiliser le nouveau format.

Ce qui a changé dans le format de payload de la version 1.0 à la version 2.0 :

1. Toutes les données d’événement se trouvaient dans l’ properties objet. Elles se trouvent désormais à la racine. L’ properties objet n’existe plus.

2. Toutes les métadonnées contextuelles se trouvaient à la racine, elles se trouvent désormais dans un nouvel context objet. Par exemple, ces objets de métadonnées event_id, device, page, app, event_timestamp se trouvent maintenant dans l’ context objet.

L’HTTP Tracking API 1.0 vous permet d’enregistrer des données depuis n’importe quel site web ou application. Les requêtes sont acheminées vers nos serveurs, et vos données sont acheminées vers toute destination souhaitée.

Configuration

Headers

Authentication

Authentifiez-vous auprès de la Tracking API en envoyant la Source Key de votre projet avec une requête dans les headers, comme ceci : Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==

La source key vous est fournie lorsque vous créez une source dans le source catalogue

Content-Type

Pour envoyer des données à notre HTTP API, un header content-type doit être défini sur 'application/json'.

Errors

Nous renvoyons actuellement une réponse 200 pour toutes les requêtes API ; le débogage doit donc être effectué via l’interface de la plateforme ou notre config API (event inspector ou event delivery API). La seule exception est que si la requête est trop volumineuse ou si le JSON est invalide, une réponse 400 sera renvoyée.

Max Request Size

La taille maximale est de 32KB par requête API.

Rate limit

Il n’existe pas de véritable rate limit au-delà duquel le système rejetterait vos données. Mais si vous devez importer à un rythme supérieur à 500 requests per second, veuillez contact us au préalable.

Event API

Vous pouvez utiliser l’event API pour capturer les actions effectuées par vos utilisateurs. Chaque action donne lieu à ce que l’on appelle un « event », auquel sont associées des propriétés.

Vous devez suivre les activités qui indiquent les performances de votre app, telles que Signed Up, Item Purchased et Article Bookmarked. Pour commencer, nous recommandons de suivre seulement quelques events clés. D’autres pourront facilement être ajoutés plus tard !

Exemple événement call: (obsolète)

POST  https://collect.commander1.com/events?tc_s={siteId}

{
  "event_name": "search",
  "event_id": "202110130000000000",
  "event_timestamp": 1639044446636,
  "properties": {
      "search_term": "t-shirts", 
      "user": {
          "id": "12345",
          "email":"[email protected]",
          "consent_categories": [1,3]
      }
  },
  "page": {
    "title": "Search page",
    "location": "https://shop.com/search?q=..."
  },
  "device": {
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
    "ip": "102.3.4.56", 
    "cookie":"_fbp=123; _fbc=456; _ga=789"
 }
}

Trouvez des détails sur les meilleures pratiques pour nommer les events ainsi que sur le événement method payload dans notre Spec.

Si vous souhaitez utiliser Http tracking API depuis votre application mobile plutôt que le SDK, consultez la Spécificité des events mobiles

Les timestamps pris en charge sont en millisecondes (ms).