(deprecated) HTTP tracking API source 1.0

Obsolète

Vous utilisez l'ancienne version de l'API (version 1.0) Commanders Act cessera le support et la maintenance de la source HTTP tracking API 1.0 le 31 août 2023. Cette API sera entièrement dépréciée 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 des erreurs.

Nous vous encourageons à commencer à utiliser le nouveau format de payload dès que possible afin d'assurer une transition fluide. Le nouveau format est décrit ici. Veuillez consulter notre documentation pour plus d'informations sur la façon d'utiliser le nouveau format.

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

1. Toutes les données d'événement étaient à l'intérieur de la properties objet. Elles sont maintenant à la racine. L' properties objet n'existe plus.

2. Toutes les méta-données contextuelles étaient à la racine, elles sont maintenant dans un nouvel context objet. Par exemple ces méta-données objets event_id, device, page, app, event_timestamp sont 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 routées vers nos serveurs, et vos données sont envoyées vers n'importe quelle destination de votre choix.

Installation

Headers

Authentication

Authentifiez-vous auprès de la Tracking API en envoyant le 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, ainsi le débogage doit être effectué en utilisant l'interface de la plateforme ou notre config API (event inspector or event delivery API). La seule exception est que si la requête est trop volumineuse ou si le JSON est invalide, elle renverra un 400.

Max Request Size

Il y a un maximum de 32KB par requête API.

Rate limit

Il n'existe pas de véritable limite de débit au-dessus de laquelle le système rejettera vos données. Mais si vous avez besoin d'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 que vos utilisateurs effectuent. Chaque action donne lieu à ce que l'on appelle un "event", qui possède des properties associées.

Vous devriez suivre les activités qui sont des indicateurs de la performance de votre app, telles que Signed Up, Item Purchased, et Article Bookmarked. Pour commencer, nous recommandons de tracker seulement quelques events clés. D'autres peuvent être ajoutés facilement plus tard !

Exemple event call: ()

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 best practices in event naming ainsi que la event method payload dans notre Spec.

Si vous souhaitez utiliser Http tracking API depuis votre application mobile au lieu du SDK, regardez la Mobile event specificity

Les timestamps supportés sont en millisecondes (ms).