Wir freuen uns, die Veröffentlichung neuer Endpunkte der Kinsta-API bekannt geben zu können, die es dir ermöglichen, detaillierte Analysen über deine Anwendungen abzurufen und Informationen über die Nutzer deines Unternehmens auf Kinsta zu erhalten.

Seit der Einführung unseres Anwendungs-Hosting-Dienstes haben wir Analysen auf Anwendungsebene zur Verfügung gestellt, die die Bandbreite, die Erstellungszeit, die Laufzeit, die CPU- und Speichernutzung, die durchschnittliche Antwortzeit, die HTTP-Anfragen und die langsamsten Anfragen über das MyKinsta-Dashboard (Anwendungen > Appname > Analysen) aufzeigen.

Im MyKinsta-Dashboard kannst du die Analysedaten für jede Anwendung abrufen
Im MyKinsta-Dashboard kannst du die Analysedaten für jede Anwendung abrufen

Jetzt können diese Kennzahlen auch programmatisch über die Kinsta-API abgerufen werden.

Neue Metrik-Endpunkte für deine Anwendungen

Du kannst jetzt über die Kinsta-API auf die folgenden Analysedaten zugreifen:

  • Bandbreite – Insgesamt übertragene Daten im ausgewählten Zeitraum.
  • Erstellungszeit – Gesamtzeit, die für die Erstellung deiner Anwendung benötigt wurde.
  • Laufzeit – Gesamtzeit, in der die Anwendung nach dem Erstellen und Bereitstellen läuft.
  • HTTP-Anfragen pro Minute – Summe der durchschnittlichen Anfragen pro Minute.
  • Durchschnittliche Antwortzeit – Die durchschnittliche Antwortzeit auf eine Anfrage. (Wenn die Abfrage der Antwortzeit den Parameter percent mit Werten von 95 oder 50 enthält, werden die Antwortzeiten P95 Latenz oder P50 Latenz zurückgegeben).
  • Langsamste Anfragen – Hier siehst du genau, welche Antworten innerhalb deiner Anwendung am langsamsten sind.
  • CPU-Auslastung – Der Durchschnitt der gesamten CPU-Auslastung für den ausgewählten Zeitraum, als Prozentsatz der CPU-Ressourcen der Instanz.
  • Speichernutzung – Der Durchschnitt der gesamten Speichernutzung (RAM) für den ausgewählten Zeitraum.

In der Kinsta-API-Dokumentation findest du den erforderlichen Pfad und die Abfrageparameter für den Zugriff auf diese Metriken. Um zum Beispiel die tägliche Bandbreitennutzung abzurufen, sende eine GET-Anfrage an:

https://api.kinsta.com/v2/applications/{id}/metrics/bandwidth
Kinsta-API-Dokumentation mit verschiedenen Parametern zum Abrufen von Bandbreitenmetriken
Kinsta-API-Dokumentation mit verschiedenen Parametern zum Abrufen von Bandbreitenmetriken

Diese Anfrage benötigt die folgenden Parameter:

  • Pfad-Parameter:
    • id – Dies ist die Anwendungs-ID und wird der API-URL hinzugefügt.
  • Abfrageparameter:
    • interval_in_seconds – Dieser Parameter ist erforderlich und wird in Sekunden gemessen. Wenn du möchtest, dass das Intervall zwischen den zurückgegebenen Werten 24 Stunden beträgt, musst du 24 Stunden in Sekunden umrechnen, was 86400 entspricht.
    • timeframe_start und timeframe_end – Diese Parameter sind erforderlich, und es wird das ISO 8601 Datums-Zeitformat verwendet. Es hat ein allgemeines Format von YYYY-MM-DDThh:mm:ss.sssZ.

Hier findest du eine detaillierte Aufschlüsselung des ISO 8601 Datums- und Zeitformats:

  • JJJJ-MM-DD – Stellt das Datum dar:
    • JJJJ – Vierstelliges Jahr
    • MM – Zweistelliger Monat (01 bis 12)
    • DD – Zweistelliger Tag des Monats (01 bis 31)
  • T – Der Buchstabe T wird als Trennzeichen verwendet, um zwischen Datum und Uhrzeit zu unterscheiden.
  • hh:mm:ss.sss – Steht für die Uhrzeit:
    • hh – Zweistellige Stunde (00 bis 23)
    • mm – Zweistellige Minute (00 bis 59)
    • ss – Zweistellige Sekunde (00 bis 59)
    • .sss – Millisekunden, die ein- bis dreistellig sein können und einen Bruchteil einer Sekunde darstellen
  • Z – Gibt an, dass die Zeit auf UTC (Coordinated Universal Time) eingestellt ist. Wenn die Zeit nicht in UTC ist, kann anstelle von „Z“ auch eine Zeitverschiebung im Format ±hh:mm angegeben werden, wobei „hh“ für den Stundenunterschied und „mm“ für den Minutenunterschied zur UTC steht.

Zurück zu unserem Beispiel: Du kannst eine GET-Anfrage senden, um die täglichen Daten zwischen dem 20. April 2024 und dem 28. April 2024 abzurufen:

curl -i -X GET \
'https://api.kinsta.com/v2/applications/{application_id}/metrics/bandwidth?interval_in_seconds=86400&timeframe_start=2024-04-20T18%3A10%3A45.511Z&timeframe_end=2024-04-28T18%3A10%3A45.511Z' \
  -H 'Authorization: Bearer '

Ersetze {application_id} und <YOUR_TOKEN_HERE> durch deine Anwendungs-ID bzw. dein API-Token. Wenn du diese Anfrage sendest, wird das folgende Datenformat zurückgegeben:

{
  "app": {
    "id": "MY_APP_ID",
    "display_name": "Kinsta-developer-portfolio",
    "metrics": {
      "timeframe": {
        "start": "1713571200000",
        "end": "1714262400000"
      },
      "bandwidth": [
        {
          "time": "1713571200000",
          "value": "18205"
        },
        {
          "time": "1713657600000",
          "value": "834750"
        },
        {
          "time": "1713744000000",
          "value": "146959"
        },
        {
          "time": "1713830400000",
          "value": "142413"
        },
        {
          "time": "1713916800000",
          "value": "165352"
        },
        {
          "time": "1714089600000",
          "value": "109015"
        },
        {
          "time": "1714176000000",
          "value": "628641"
        }
      ]
    }
  }
}

Die Antwort gibt den Beginn und das Ende des Zeitraums an, basierend auf dem, was über die Anfrage gesendet wurde. Wenn du sie in den new Date()Konstruktor einträgst, erhältst du das Datum/Zeit-Objekt. Außerdem gibt die Bandbreite ein Array von Objekten zurück, das die Zeit (Zeitstempel, der für jeden Tag angegeben wird – basierend auf dem eingestellten Intervall) und den Wert in Bytes enthält.

Wenn du jede dieser Daten entsprechend umwandelst, bedeutet das Folgendes:

Zeitrahmen

  • Start: 2024-04-20 00:00:00
  • Ende: 2024-04-29 00:00:00

Bandbreite (umgerechnet in MB)

  • Zeit: 2024-04-20 00:00:00, Wert: 0.0174 MB
  • Zeit: 2024-04-21 00:00:00, Wert: 0.7961 MB
  • Zeit: 2024-04-22 00:00:00, Wert: 0,1402 MB
  • Zeit: 2024-04-23 00:00:00, Wert: 0.1358 MB
  • Zeit: 2024-04-24 00:00:00, Wert: 0.1577 MB
  • Zeit: 2024-04-26 00:00:00, Wert: 0.1040 MB
  • Zeit: 2024-04-27 00:00:00, Wert: 0.5995 MB
  • Zeit: 2024-04-28 00:00:00, Wert: 5.8086 MB

Das bedeutet, dass du programmatisch Informationen über jede dieser analytischen Informationen in einer anderen Plattform abrufen kannst, ohne dass du für jede Anwendung im MyKinsta-Dashboard navigieren musst.

Du kannst zum Beispiel einen Slackbot erstellen, der den Slash-Befehl von Slack nutzt, um diese Informationen von Slack abzurufen, oder eine Erinnerung erstellen, die dich informiert, wenn die tägliche Bandbreiten-, CPU- oder Speichernutzung einen bestimmten Schwellenwert überschreitet.

Zugriff auf Unternehmensnutzer mit der Kinsta-API

Als Reaktion auf Kundenanfragen haben wir einen Endpunkt hinzugefügt, mit dem du Details über die Nutzer von Kinsta-Unternehmenskonten abrufen kannst, einschließlich ihres vollständigen Namens, ihrer E-Mail und der URL ihres Gravatar-Bildes.

Dies entspricht unserer Verpflichtung, Funktionen auf der Grundlage von Nutzerfeedback zu priorisieren. Wenn du meinst, dass ein bestimmtes Tool oder ein Endpunkt in die Kinsta-API aufgenommen werden sollte, kannst du uns gerne dein Feedback schicken.

Um auf diese Daten zuzugreifen, sende eine GET-Anfrage an: https://api.kinsta.com/v2/company/{company_id}/users. Ersetze dabei {company_id} durch deine Unternehmens-ID. Du erhältst dann eine Antwort wie folgt:

{
  "company": {
    "users": [
      {
        "user": {
          "id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
          "email": "[email protected]",
          "image": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "full_name": "John Doe"
        }
      }
    ]
  }
}

Starten Sie noch heute mit der Kinsta-API

Um die Kinsta-API zu nutzen, brauchst du ein aktives Kinsta-Konto mit mindestens einer WordPress-Website, -Anwendung oder -Datenbank in MyKinsta. Hier erfährst du, wie du einen API-Schlüssel generierst:

  1. Gehe zu deinem MyKinsta-Dashboard.
  2. Navigiere zur Seite mit den API-Schlüsseln (Dein Name > Unternehmenseinstellungen > API-Schlüssel).
  3. Klicke auf API-Schlüssel generieren.
  4. Wähle ein Ablaufdatum oder lege ein benutzerdefiniertes Startdatum und die Anzahl der Stunden fest, nach denen der Schlüssel abläuft.
  5. Gib dem Schlüssel einen eindeutigen Namen.
  6. Klicke auf Generieren.

Wenn der API-Schlüssel generiert wurde, kopiere ihn und bewahre ihn an einem sicheren Ort auf, da nur du ihn dann sehen kannst. Wir empfehlen, einen Passwortmanager wie 1Password zu verwenden, um ihn sicher zu teilen.

Mit der Kinsta-API kannst du eine Menge anstellen. Schau dir unsere Dokumentation an, um zu verstehen, was mit der API möglich ist, wie du loslegst und welche Berechtigungsstufen und Einschränkungen es für die API gibt.

Du kannst dir auch unsere früheren Änderungsprotokolle für die Kinsta-API ansehen: