Nous sommes heureux d’annoncer la publication de nouveaux points de terminaison sur l’API Kinsta qui vous permettent d’accéder à des analyses détaillées sur vos applications et de récupérer des informations sur les utilisateurs de votre entreprise sur Kinsta.

Depuis le lancement de notre service d’hébergement d’applications, nous avons fourni des analyses au niveau de l’application qui détaillent la bande passante, le temps de construction, le temps d’exécution, l’utilisation du CPU et de la mémoire, le temps de réponse moyen, les requêtes HTTP et les requêtes les plus lentes via le tableau de bord MyKinsta (Applications > Nom de l’application > Analyses).

Accédez aux informations analytiques pour chaque application dans le tableau de bord MyKinsta.
Accédez aux informations analytiques pour chaque application dans le tableau de bord MyKinsta.

Désormais, il est possible d’accéder à ces mesures de manière programmatique via l’API Kinsta.

Nouvelles mesures de points de terminaison pour vos applications

Vous pouvez désormais accéder aux informations analytiques suivantes via l’API de Kinsta :

  • Bande passante – Total des données transmises au cours de la période sélectionnée.
  • Temps de construction – Temps total nécessaire à la construction de votre application.
  • Durée d’exécution – Durée totale d’exécution de l’application après sa construction et son déploiement.
  • Requêtes HTTP par minute – Total des requêtes moyennes par minute.
  • Temps de réponse moyen – Temps de réponse moyen des requêtes. (Si la requête sur le temps de réponse inclut le paramètre percent avec des valeurs de 95 ou 50, les temps de réponse P95 ou P50 seront renvoyés).
  • Demandes les plus lentes – Ce réglage vous indique exactement quelles sont les réponses les plus lentes dans votre application.
  • Utilisation du CPU – La moyenne de l’utilisation totale du CPU pour la période sélectionnée, en pourcentage des ressources du CPU de l’instance.
  • Utilisation de la mémoire – Moyenne de l’utilisation totale de la mémoire (RAM) pour la période sélectionnée.

La documentation de l’API Kinsta fournit le chemin d’accès et les paramètres de requête nécessaires pour accéder à ces mesures. Par exemple, pour récupérer les données d’utilisation quotidienne de la bande passante, envoyez une requête GET à :

https://api.kinsta.com/v2/applications/{id}/metrics/bandwidth
La documentation de l'API Kinsta montre les différents paramètres permettant de récupérer les informations sur la bande passante.
La documentation de l’API Kinsta montre les différents paramètres permettant de récupérer les informations sur la bande passante.

Cette requête nécessitera les paramètres suivants :

  • Paramètre de chemin :
    • id – Il s’agit de l’identifiant de l’application, qui sera ajouté à l’URL de l’API.
  • Paramètres de requête :
    • interval_in_seconds – Si vous souhaitez que l’intervalle entre les valeurs renvoyées soit de 24 heures, vous devez convertir 24 heures en secondes, soit 86400.
    • timeframe_start et timeframe_end – Ces paramètres sont obligatoires et le format de date et d’heure ISO 8601 est utilisé. Le format général est le suivant : YYYY-MM-DDThh:mm:ss.sssZ.

Vous trouverez ici une description détaillée du format de date et d’heure ISO 8601 :

  • AAAA-MM-JJ – Représente la date :
    • AAAA – Année à quatre chiffres
    • MM – Deux chiffres du mois (01 à 12)
    • DD – Jour du mois à deux chiffres (01 à 31)
  • T – La lettre T est utilisée comme séparateur pour distinguer clairement les parties date et heure.
  • hh:mm:ss.sss – Représente l’heure :
    • hh – Heure à deux chiffres (00 à 23)
    • mm – minute à deux chiffres (00 à 59)
    • ss – Seconde à deux chiffres (00 à 59)
    • .sss – Millisecondes, de un à trois chiffres, représentant une fraction de seconde
  • Z – Indique que l’heure est réglée sur UTC (Coordinated Universal Time). Si l’heure n’est pas en UTC, un décalage horaire peut également être inclus à la place de « Z », formaté comme ±hh:mm, où « hh  représente la différence d’heure et « mm » représente la différence de minute par rapport à l’UTC.

Pour revenir à notre exemple, vous pouvez envoyer une requête GET pour récupérer les données quotidiennes entre le 20 avril 2024 et le 28 avril 2024 :

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 '

Remplacez {application_id} et <YOUR_TOKEN_HERE> par votre identifiant d’application et votre jeton API, respectivement. Lorsque vous envoyez cette requête, le format de données suivant est renvoyé :

{
  "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"
        }
      ]
    }
  }
}

La réponse spécifie le début et la fin de la période en fonction de ce qui a été envoyé par la demande. Si vous le placez dans le constructeur de new Date(), vous obtenez l’objet date/heure. La bande passante renvoie également un tableau d’objets contenant l’heure (horodatage donné pour chaque jour – sur la base de l’intervalle défini) et la valeur en octets.

Lorsque vous convertissez chacune de ces données en conséquence, vous obtenez ce qui suit :

Période

  • Début : 2024-04-20 00:00:00
  • Fin : 2024-04-29 00:00:00

Largeur de bande (convertie en Mo)

  • Heure : 2024-04-20 00:00:00, Valeur : 0.0174 Mo
  • Heure : 2024-04-21 00:00:00, Valeur : 0.7961 Mo
  • Heure : 2024-04-22 00:00:00, Valeur : 0.1402 Mo
  • Heure : 2024-04-23 00:00:00, Valeur : 0.1358 Mo
  • Heure : 2024-04-24 00:00:00, Valeur : 0.1577 Mo
  • Heure : 2024-04-26 00:00:00, Valeur : 0.1040 Mo
  • Heure : 2024-04-27 00:00:00, Valeur : 0.5995 Mo
  • Heure : 2024-04-28 00:00:00, Valeur : 5.8086 Mo

Cela signifie que vous pouvez obtenir de manière programmatique des informations sur chacune de ces informations analytiques dans une autre plateforme sans avoir besoin de naviguer dans le tableau de bord MyKinsta pour chaque application.

Par exemple, vous pouvez créer un Slackbot qui utilise la commande Slash de Slack pour accéder à ces informations depuis Slack ou créer un rappel pour vous informer lorsque l’utilisation quotidienne de la bande passante, du CPU ou de la mémoire franchit un seuil particulier.

Accéder aux utilisateurs de l’entreprise avec l’API Kinsta

En réponse aux demandes des clients, nous avons ajouté un point de terminaison pour récupérer des détails sur les utilisateurs de l’entreprise du compte Kinsta, y compris leur nom complet, leur e-ùmail et l’URL de leur image gravatar.

Cela correspond à notre engagement de prioriser les fonctionnalités en fonction des commentaires des utilisateurs. Si vous pensez qu’un outil ou un point de terminaison spécifique devrait être inclus dans l’API Kinsta, n’hésitez pas à nous faire part de vos commentaires.

Pour accéder à ces données, envoyez une requête GET à : https://api.kinsta.com/v2/company/{company_id}/users. Veillez à remplacer {company_id} par l’identifiant de votre entreprise. Vous obtiendrez une réponse de ce type :

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

Commencez à utiliser l’API Kinsta dès aujourd’hui

Pour utiliser l’API Kinsta, vous avez besoin d’un compte Kinsta actif avec au moins un site WordPress, une application ou une base de données dans MyKinsta. Voici comment générer une clé API :

  1. Allez sur votre tableau de bord MyKinsta.
  2. Naviguez jusqu’à la page des clés API (Votre nom > Réglages de l’entreprise > Clés API).
  3. Cliquez sur Créer une clé API.
  4. Choisissez une date d’expiration ou définissez une date de début personnalisée et un nombre d’heures pour l’expiration de la clé.
  5. Donnez un nom unique à la clé.
  6. Cliquez sur Générer.

Une fois la clé API créée, veillez à la copier et à la conserver en lieu sûr, car c’est la seule fois où vous pourrez la voir. Nous vous recommandons d’utiliser un gestionnaire de mots de passe tel que 1Password pour la partager en toute sécurité.

L’API Kinsta offre de nombreuses possibilités. N’hésitez pas à consulter notre documentation pour comprendre ce qui est possible avec l’API, comment commencer, et les différents niveaux de permission et les limites de l’API.

Vous pouvez également consulter nos changements précédents pour l’API Kinsta :