Suivi d'utilisation de l'API

PrécédentDevices Suivant1. Récupérer toutes les logs

Dernière mise à jour il y a 4 mois

Vue d'ensemble

Les endpoints de suivi d'utilisation permettent de suivre et d'analyser les requêtes effectuées sur le système Pulse. Elle fournit des statistiques détaillées sur le volume des requêtes, le temps d'exécution, le score de complexité, et les interactions avec les appareils.

Facturation basée sur l'utilisation

Actuellement, la facturation est déterminée en fonction du nombre d'appareils utilisés dans le mois. Chaque appareil actif pendant une période donnée est comptabilisé pour établir les coûts mensuels d'utilisation.

Le score de complexité, bien que déjà calculé et stocké, n'est pas encore utilisé pour la facturation. À terme, la facturation pourrait également prendre en compte la charge de complexité des requêtes pour affiner les coûts en fonction de l'utilisation réelle des ressources.

RequestLog

Paramètres de requête

Toutes les requêtes de statistiques peuvent etre filtrées par les parametres ci-dessous. Tous les parametres sont facultatifs:

1. Récupérer les logs d'utilisation

2. Synthèse

GET /stats/synthese

Renvoie un résumé des statistiques globales d'utilisation, incluant :

Nombre total de requêtes
Nombre d'entreprises et d'appareils actifs
Score moyen de complexité
Top 5 des routes les plus utilisées

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

{
  "totalRequests": int,
  "uniqueEnterprises": int,
  "uniqueDevices": int,
  "avgComplexity": int,
  "topRoutes": [
    { "route": string, "totalRequests": int },
    ...
  ]
}

{ 
   "message": "Erreur serveur." 
}

3. Nombre de requêtes

GET /stats/requests

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

[
  {
    "enterprise": Entreprise,
    "totalRequests": int
  },
  {
    "enterprise": Entreprise,
    "totalRequests": int
  }
]

{ 
   "message": "Erreur serveur." 
}

4. Complexité des requêtes

GET /stats/complexity

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

[
  {
    "enterprise": Entreprise,
    "averageComplexity": int
  },
  {
    "enterprise": Entreprise,
    "averageComplexity": int
  }
]

{ 
   "message": "Erreur serveur." 
}

5. Activité des appareils

GET /stats/devices

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

[
  {
    "device": Device,
    "totalRequests": int
  },
  {
    "device": Device,
    "totalRequests": int
  }
]

{ 
   "message": "Erreur serveur." 
}

6. Routes les plus utilisées

GET /stats/routes

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

[
  {
    "route": string,
    "totalRequests": int
  },
  {
    "route": string,
    "totalRequests": int
  }
]

{ 
   "message": "Erreur serveur." 
}

GET /stats

Renvoie la liste des logs d'utilisation enregistrés.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

[
  {
    "entreprise": Entreprise //"entreprise",
    "device": [Device], //"Tableau d'appareil"
    "route": string //"Endpoint appelé",
    "method": string //"Méthode HTTP",
    "timestamp": Date //"Date et heure",
    "executionTime": int //"Temps en millisecondes",
    "responseSize": int //"Taille en octets",
    "complexityScore": int //"Score calculé"
  }
]

{ 
   "message": "Erreur serveur." 
}

{
  entreprise: Entreprise;
  device: Device; // L’appareil concerné si applicable
  route: string;
  method: string;
  timestamp: Date;
  executionTime: number; // Temps de la requête en ms
  responseSize: number; // Taille de la réponse en octets
  complexityScore: number; // Score de complexité de la requête
}