# Par la mise en place d'un tag (ou pixel) sur votre site

## Étape 1 : Rajouter la balise "API Engagement" sur votre site&#x20;

La Balise API Engagement, doit être ajoutée en haut de la balise `<head>` et avant tout autre script ou balise CSS.&#x20;

```html
<script>
(function (i, s, o, g, r, a, m) {
i["ApiEngagementObject"] = r; (i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments); }), (i[r].l = 1 * new Date()); (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); a.async = 1; a.src = g; m.parentNode.insertBefore(a, m);
})(window, document, "script", "https://app.api-engagement.beta.gouv.fr/jstag.js", "apieng");
apieng("config", "votre-id-de-partenaire");
</script>
```

Ce script effectue **trois actions** principales :&#x20;

1. **Crée un élément** `<script>` pour démarrer le téléchargement asynchrone de la bibliothèque JavaScript jstag.js depuis <https://app.api-engagement.beta.gouv.fr/jstag.js>
2. **Initialise une fonction** globale apieng (appelée "file d'attente de commandes apieng()") permettant de planifier l'exécution des commandes une fois la bibliothèque jstag.js chargée et prête à être utilisée
3. **Ajoute la commande `apieng()`** à la varaiable `window` qui permet d'accéder à toutes les fonctionnalités de tracking de l'API Engagement.

## Étape 2 : S'assurer que le lien de redirection de l'API est visible sur le bouton (ou la bannière)

* Pour le vérifier, il vous suffit de faire clic droit, puis "Inspecter". Dans la console, vous devez voir un lien dans la balise de type \<a href="[https://api.api-engagement.beta.gouv.fr/r/.......">](https://api.api-engagement.beta.gouv.fr/r/.......">) \</a>
* Si ce lien est visible, alors il n'y a rien de plus à faire et l'API pourra tracker les impressions.

⚠️ S'il n'est pas possible de mettre le lien visible tel que mentionné ci-dessus, consultez l'[alternative expliquée ci-dessous](#altenative-tracking-des-impressions-par-le-pixel-utilisable-dans-le-contexte-de-la-diffusion-de-miss) :&#x20;

<figure><img src="/files/FQg3wDnwEfzcZxWQC3GJ" alt=""><figcaption><p>Exemple de lien de redirection visible pour une diffusion par API</p></figcaption></figure>

<figure><img src="/files/FCoNQo3i46ZpO0TAHzQP" alt=""><figcaption><p>Exemple de lien de redirection visible pour une diffusion par lien tracké</p></figcaption></figure>

## Alternative : Tracking des impressions par le pixel (utilisable dans le contexte de la diffusion de missions par API ou pour les liens trackés)

* **Le rajout de la balise décrite en (1.) reste requis.** Cependant, si l'implémentation décrite en (2.) ne convient pas, alors il est possible de tracker les impressions via la méthode du pixel.
* Sur le bouton (ou la bannière) qui sert à rediriger les utilisateurs vers la page cible (de l'annonceur), vous devez ajouter une balise \<span> de la forme suivante :

```
<span name="tracker_counter" data-id="mission_id" /> 
```

où `tracker_counter` n’est pas à changer (c’est avec ce nom que le script retrouve le tracker) et `mission_id` est l’identifiant que l’API fournit de la mission.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/partager-vos-statistiques-de-diffusions-impressions-a-lapi-engagement/par-la-mise-en-place-dun-tag-ou-pixel-sur-votre-site.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
