> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir les statistiques des affaires

> Obtenir le nombre d'affaires selon des critères (date, type d'affaire et catégorie d'affaire).

### Endpoint & Authentification

| Méthode | URL                                                        |
| :------ | :--------------------------------------------------------- |
| `POST`  | `https://app.arquos.eu/api/1.1/wf/get_opportunities_stats` |

**En-têtes (Headers) :**

* `x-api-key: [VOTRE_API_KEY]`

<Note>
  La clé API est propre à chaque partenaire et n'est autorisée que sur les agences qui lui ont été attribuées. Les statistiques renvoyées sont limitées à l'agence indiquée dans `agency_id`.
</Note>

### Paramètres de la requête (Body)

<ParamField body="agency_id" type="string" required>
  Identifiant unique de l'agence. Les statistiques sont calculées uniquement sur cette agence, qui doit faire partie des agences autorisées pour votre clé.
</ParamField>

<ParamField body="from" type="date">
  Date de création de début.
</ParamField>

<ParamField body="to" type="date">
  Date de création de fin.
</ParamField>

<ParamField body="opportunity_type" type="string">
  Type d'affaire. Valeurs possibles : `Contrat`, `Réparation`, `Modernisation pour devis`, `Remplacement complet pour devis`, `Modernisation pour commande`, `Remplacement complet pour commande`.
</ParamField>

<ParamField body="opportunity_category" type="string">
  Catégorie de l'affaire. Valeurs possibles : `Ouverte`, `En attente`, `En retard`, `Gagnée`, `Perdue`, `Annulée`, `Fermée`.
</ParamField>

### Réponse

L'API retourne un objet contenant le nombre d'affaires correspondant aux critères.

<Expandable title="Caractéristiques techniques" defaultOpen="true">
  <ResponseField name="opportunities_count" type="number">
    Nombre d'affaires correspondant aux critères.
  </ResponseField>
</Expandable>

<RequestExample>
  ```json JSON theme={null}
  {
    "agency_id": "test_agency_01",
    "from": "2026-01-01",
    "to": "2026-12-12",
    "opportunity_type": "Contrat",
    "opportunity_category": "Gagnée"
  }
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://app.arquos.eu/api/1.1/wf/get_opportunities_stats \
    --header 'x-api-key: VOTRE_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
      "agency_id": "test_agency_01",
      "from": "2026-01-01",
      "to": "2026-12-12",
      "opportunity_type": "Contrat",
      "opportunity_category": "Gagnée"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "response": {
      "opportunities_count": 6
    }
  }
  ```
</ResponseExample>