> For the complete documentation index, see [llms.txt](https://doc.api-engagement.beta.gouv.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/rajout-de-la-balise-et-des-commandes-de-tracking-par-le-tag.md).

# Rajout de la balise et des commandes de tracking par le tag

## 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.

## 2. Comment mesurer une candidature ?

Lorsqu'une candidature est validée sur votre site dans le cadre d'une redirection, il faut exécuter la commande suivante :&#x20;

```html
window.apieng && window.apieng("trackApplication", clientId)
```

⚠️ Par défaut, il est fortement conseillé d'ajouter, si connu, l'**identifiant** **de la mission pour laquelle cette candidature est associée** (`clientId` = votre identifiant de mission utilisé dans le flux XML)**.** Informer le clientId pour laquelle il y a eu une candidature permet à l’API de fournir des statistiques poussées.

NB : Si vous ne l'avez pas, ne l’indiquez pas dans la commande. La commande de **comptage d'une candidature** sera la suivante :&#x20;

```html
window.apieng && window.apieng("trackApplication")
```

#### Paramètres additionnels

**Identifiant client**

Vous pouvez ajouter un identifiant client permettant de modifier le statut candidature a posteriori (voir documentation API `/v2/activity`).

```
window.apieng && window.apieng("trackApplication", missionId, {
  clientEventId: "evt_12345",
})
```

**Custom attributes**

Vous pouvez également ajouter des paramètres supplémentaires, au format JSON, qui vous permettraient de qualifier la candidature, de façon suivante :&#x20;

```
window.apieng && window.apieng("trackApplication", missionId, { 
    customAttributes: {candidateAge: 22, candidatePostalCode: "89140"}
})
```

Ces paramètres sont bien sûr cumulables :&#x20;

```
window.apieng && window.apieng("trackApplication", undefined, {
  clientEventId: "evt_12345",
  customAttributes: { candidateAge: 22 }
})
```

## 3. Comment mesurer une création de compte ?

Lorsqu'un compte utilisateur est créé sur votre site suite à une redirection, il faut exécuter la commande suivante :&#x20;

```html
window.apieng && window.apieng("trackAccount", clientId)
```

⚠️ Par défaut, il est fortement conseillé d'ajouter, si connu, **l'identifiant**  **de la mission pour laquelle cette création de compte est associée** (`clientId` = votre identifiant de mission utilisé dans le flux XML). Informer le clientId pour laquelle il y a eu une création de compte permet à l’API de fournir des statistiques poussées :

NB: Si vous ne l'avez pas, ne l’indiquez pas dans la commande. La commande de **comptage d'une création de compte** sera la suivante :

```html
window.apieng && window.apieng("trackAccount")
```

## 4. Quand effectuer ces commandes ?

Les commandes de création de compte et de création d'une candidature sont à effectuer lorsque vous êtes sûr que cet évènement est arrivé.&#x20;

Par exemple pour une création de compte avec un fonctionnement front-back, cette commande est à déclencher lorsque le backend a confirmé la création du compte en base.

## 5. Où retrouver ces commandes ?

Vous pouvez trouver cette commande sur votre **espace partenaire** dans la partie [**Paramètres &#x20;*****>  Tracking des événements***](https://app.api-engagement.beta.gouv.fr/settings/tracking)

<figure><img src="/files/pqOzaghRpzdxB8hjul9n" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/annoncer-des-missions/tracking-des-candidatures/rajout-de-la-balise-et-des-commandes-de-tracking-par-le-tag.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.
