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

# Reporting et suivi de l’usage de la plateforme

> Découvrez comment suivre l’usage de la plateforme et de l’API grâce aux endpoints de reporting, pour construire vos propres tableaux de bord et indicateurs personnalisés.

## Historique

Jusqu’à la version **Sunny Seal**, la plateforme proposait une page *Analytics* intégrée.\
Celle-ci permettait de suivre des indicateurs tels que :

* le volume de requêtes,
* la satisfaction des utilisateurs,
* les métriques d’usage globales.

Cependant, au fil du temps, nous avons constaté que **chaque client avait des besoins spécifiques en matière de reporting**. Un tableau de bord unique ne pouvait pas convenir à tous les cas d’usage. Nous avons donc choisi de **déprécier la page Analytics** à partir de Sunny Seal.

## Nouvelle stratégie : flexibilité par l’API

Plutôt que d’imposer une interface générique, nous avons fait évoluer notre approche.\
Désormais, le suivi d’usage passe par une série d’**endpoints d’API** qui donnent accès à des données brutes.

Ce choix apporte deux avantages majeurs :

1. **Flexibilité totale** : chaque client peut construire ses propres dashboards et rapports adaptés à son contexte.
2. **Intégration simple** : les données peuvent être directement intégrées dans vos systèmes existants (BI tools, CRM, monitoring interne, etc.).

## Endpoints disponibles

Vous pouvez interroger les endpoints suivants pour obtenir vos rapports :

* [Get Chat Sessions Report](https://lighton.mintlify.app/api-reference/reporting/get-chat-sessions-report)
* [Get Chat Feedbacks Report](https://lighton.mintlify.app/api-reference/reporting/get-chat-feedbacks-report)
* [Get Tools Report](https://lighton.mintlify.app/api-reference/reporting/get-tools-report)
* [Get Used Documents Report](https://lighton.mintlify.app/api-reference/reporting/get-used-documents-report)
* [Get User Activities Report](https://lighton.mintlify.app/api-reference/reporting/get-user-activities-report)

***

# Comment utiliser les endpoints

### Authentification

Tous les appels nécessitent une **clé API** transmise dans le header d’autorisation :

```
Authorization: Bearer <YOUR_API_TOKEN>
```

### Paramètres communs

* `start_date` *(obligatoire)* : date de début au format `YYYY-MM-DD`.
* `end_date` *(optionnel)* : date de fin, défaut = aujourd’hui.
* Selon l’endpoint, d’autres filtres peuvent être disponibles (ex : ID utilisateur, modèle, etc.).

***

## Exemple : Get Chat Sessions Report

### cURL

```
curl --request GET \
  --url "https://paradigm-preprod.lighton.ai/api/v2/reporting/chat-sessions/?start_date=2023-12-01&end_date=2023-12-31" \
  --header "Authorization: Bearer <YOUR_API_TOKEN>"
```

### Python

```
import requests

url = "https://paradigm-preprod.lighton.ai/api/v2/reporting/chat-sessions/"
params = {"start_date": "2023-12-01", "end_date": "2023-12-31"}
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers, params=params)
data = response.json()

print(data["reporting"][0]["dates"][0]["sessions"])
```

### Exemple de réponse JSON

```
{
  "metadata": {
    "sessions_count": {"description": "Total des sessions", "unit": "integer"},
    "average_session_length": {"description": "Durée moyenne des sessions", "unit": "seconds"}
  },
  "reporting": [
    {
      "company": {"name": "ACME Corp", "id": 123},
      "dates": [
        {
          "date": "2023-12-25",
          "sessions": {
            "sessions_count": 45,
            "unique_models_count": 3,
            "average_session_length": 120
          },
          "chats": {
            "user_queries_count": 200,
            "model_responses_count": 190,
            "last_model_response_date": "2023-12-25T22:30:00Z"
          }
        }
      ]
    }
  ]
}
```

***

## Cas d’usage

* **Tableaux de bord BI** : connecter ces données à PowerBI, Looker ou Tableau pour suivre l’adoption.
* **Alertes internes** : générer des notifications (ex : dépassement d’un seuil de requêtes).
* **Pilotage produit** : suivre quels outils ou documents sont le plus utilisés.

***

# FAQ

### Quels filtres sont disponibles ?

Chaque endpoint supporte des paramètres de dates, et certains acceptent des filtres supplémentaires (ex : ID utilisateur, modèle, document). Voir la doc détaillée de chaque endpoint.

### À quelle fréquence puis-je appeler l’API ?

Vous pouvez interroger l’API aussi souvent que nécessaire, mais nous recommandons d’**agréger les données quotidiennement ou hebdomadairement** pour limiter la charge.

### Est-ce que vous proposez encore une interface de reporting intégrée ?

Non. L’approche retenue est **API-only**, pour garantir flexibilité et scalabilité.

### Puis-je combiner plusieurs endpoints ?

Oui, par exemple :

* Sessions + Feedbacks = suivi de l’adoption et de la satisfaction.
* Documents + Tools = suivi de l’utilisation des ressources internes.