Dashboard Rapport - Geconsolideerde API-verzoeken

Gegevens en rapportage
, ,
1

Dit is een SQL-versie van het Dashboardrapport voor Geconsolideerde API-verzoeken.

Dit rapport toont API-gebruiksstatistieken per datum, waarbij zowel reguliere API-verzoeken als gebruikers-API-verzoeken worden bijgehouden. Dit rapport helpt u de API-gebruikspatronen op uw Discourse-instantie in de loop van de tijd te volgen. Het onderscheidt tussen reguliere API-verzoeken en gebruikers-API-verzoeken, en toont beide afzonderlijk samen met het totale gecombineerde aantal.

De gegevens zijn afkomstig uit de tabel application_requests die verschillende soorten verzoeken in het systeem bijhoudt. Voor API-gebruik richten we ons op de verzoektypen 11 (regulier API) en 12 (gebruiker API).

-- [params]
-- date :start_date = 2023-01-01
-- date :end_date = 2025-12-31

SELECT 
  ar.date,
  -- API requests
  SUM(CASE WHEN ar.req_type = 11 THEN ar.count ELSE 0 END) AS api,
  SUM(CASE WHEN ar.req_type = 12 THEN ar.count ELSE 0 END) AS user_api,
  -- Total API requests
  SUM(CASE WHEN ar.req_type IN (11, 12) THEN ar.count ELSE 0 END) AS total_api_requests
FROM 
  application_requests ar
WHERE 
  ar.date BETWEEN :start_date AND :end_date
GROUP BY 
  ar.date
ORDER BY 
  ar.date DESC

Parameters:

  • De query accepteert twee parameters, :start_date en :end_date, die het datumbereik voor het rapport definiëren. Beide datumparameters accepteren het datumformaat JJJJ-MM-DD.

Resultaten

  • date: Datum van de tellingen van verzoeken
  • api: Aantal reguliere API-verzoeken (req_type = 11)
  • user_api: Aantal gebruikers-API-verzoeken (req_type = 12)
  • total_api_requests: Som van alle API-verzoeken

Wat is het verschil tussen reguliere API- en gebruikers-API-verzoeken?

  • Reguliere API-verzoeken (req_type = 11): Dit zijn API-aanroepen die naar het systeem worden gedaan en geen gebruikersauthenticatie vereisen. Ze omvatten openbare API-eindpunten, systeemintegraties of externe services die toegang hebben tot openbare gegevens.
  • Gebruikers-API-verzoeken (req_type = 12): Dit zijn API-aanroepen die worden gedaan met gebruikersauthenticatie, die doorgaans acties vertegenwoordigen die namens specifieke gebruikers worden uitgevoerd en de gebruiker van een API-sleutel vereisen.

Voorbeeldresultaten

date api user_api total_api_requests
2023-09-15 34.582 7.249 41.831
2023-09-14 32.104 6.893 38.997
2023-09-13 33.756 7.122 40.878
2023-09-12 35.122 8.562 43.684
2023-09-11 36.475 9.234 45.709
2023-09-10 12.563 3.298 15.861
2023-09-09 10.782 2.982 13.764
2023-09-08 33.892 7.456 41.348
2023-09-07 31.765 7.120 38.885
2023-09-06 32.451 7.321 39.772
6 likes