Temos o prazer de anunciar o lançamento de novos endpoints na API da Kinsta que permitem que você acesse análises detalhadas sobre seus aplicativos e recupere informações sobre os usuários da sua empresa na Kinsta.
Desde o lançamento do nosso serviço de Hospedagem de Aplicativos, fornecemos análises no nível do aplicativo que detalham a largura de banda, tempo de build, runtime, usos de CPU e memória, tempo médio de resposta, solicitações HTTP e as solicitações mais lentas do seu aplicativo por meio do painel MyKinsta (Aplicativos > nome do aplicativo > Análises).
Agora, essas métricas podem ser acessadas de forma programática por meio da API da Kinsta.
Novos endpoints de métricas para seus aplicativos
Agora você pode acessar as seguintes informações de análise por meio da API da Kinsta:
- Largura de banda — Total de dados transmitidos no período de tempo selecionado.
- Tempo de build — Tempo total para criar seu aplicativo.
- Runtime — Tempo total em que o aplicativo é executado após ser criado e implantado.
- Solicitações HTTP por minuto — Média total de solicitações por minuto.
- Tempo médio de resposta — O tempo médio de resposta da solicitação. (Se a consulta de tempo de resposta incluir o parâmetro
percentcom valores de 95 ou 50, serão retornados os tempos de resposta de latência P95 ou P50). - Solicitações mais lentas — Isso mostra a você exatamente quais respostas são as mais lentas no aplicativo.
- Uso da CPU — A média do uso total da CPU para o período selecionado, como uma porcentagem dos recursos da CPU da instância.
- Uso de memória — Uma média do uso total de memória (RAM) para o período selecionado.
A documentação da API da Kinsta fornece o caminho e os parâmetros de consulta necessários para acessar essas métricas. Por exemplo, para recuperar dados diários de uso de largura de banda, envie uma solicitação GET para:
https://api.kinsta.com/v2/applications/{id}/metrics/bandwidth
Essa solicitação exigirá os seguintes parâmetros:
- Parâmetro do caminho:
id— Esse é o ID do aplicativo e será adicionado à URL da API.
- Parâmetros de consulta:
interval_in_seconds— É obrigatório e medido em segundos. Se você quiser que o intervalo entre os valores retornados seja de 24 horas, converta 24 horas em segundos, que é 86400.timeframe_startetimeframe_end— Esses parâmetros são obrigatórios, e o formato de data e hora ISO 8601 é usado. Ele tem um formato geral deYYYY-MM-DDThh:mm:ss.sssZ.
Uma análise detalhada do formato de data e hora ISO 8601:
- YYYY-MM-DD — Representa a data:
- YYYY — Ano com quatro dígitos
- MM — Mês com dois dígitos (01 a 12)
- DD — Dia do mês com dois dígitos (01 a 31)
- T — A letra T é usada como um separador para distinguir claramente entre as partes da data e da hora.
- hh:mm:ss.sss — Representa a hora:
- hh — Hora com dois dígitos (00 a 23)
- mm — Minuto com dois dígitos (00 a 59)
- ss — Segundo com dois dígitos (00 a 59)
- .sss — Milissegundos, que podem ter de um a três dígitos, representando uma parte fracionária de um segundo
- Z — Indica que a hora está definida como UTC (Tempo Universal Coordenado). Se a hora não estiver em UTC, você também pode incluir um deslocamento de hora no lugar de “Z”, formatado como ±hh:mm, em que “hh” representa a diferença da hora e “mm” a diferença de minutos em relação ao UTC.
Voltando ao nosso exemplo, você pode enviar uma solicitação GET para recuperar dados diários entre 20 de abril de 2024 e 28 de abril de 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 'Substitua {application_id} e <YOUR_TOKEN_HERE> por seu ID de aplicativo e token de API, respectivamente. Quando você envia essa solicitação, o seguinte formato de dados é retornado:
{
"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"
}
]
}
}
}A resposta especifica o início e o fim do período de tempo com base no que foi enviado por meio da solicitação. Se você colocar isso no construtor new Date(), obterá o objeto data/hora. Além disso, a largura de banda retorna um array de objetos contendo a hora (timestamp fornecido para cada dia — com base no intervalo definido) e o valor em bytes.
Quando você converte cada um desses dados de acordo, isso significa o seguinte:
Intervalo de tempo
- Início: 2024-04-20 00:00:00
- Fim: 2024-04-29 00:00:00
Largura de banda (convertida para MB)
- Hora: 2024-04-20 00:00:00, Valor: 0.0174 MB
- Hora: 2024-04-21 00:00:00, Valor: 0.7961 MB
- Hora: 2024-04-22 00:00:00, Valor: 0.1402 MB
- Hora: 2024-04-23 00:00:00, Valor: 0.1358 MB
- Hora: 2024-04-24 00:00:00, Valor: 0.1577 MB
- Hora: 2024-04-26 00:00:00, Valor: 0.1040 MB
- Hora: 2024-04-27 00:00:00, Valor: 0.5995 MB
- Hora: 2024-04-28 00:00:00, Valor: 5.8086 MB
Isso significa que você pode obter programaticamente informações sobre cada um desses dados analíticos em outra plataforma sem precisar navegar no painel MyKinsta para cada aplicativo.
Por exemplo, você pode criar um Slackbot que use o comando Slash do Slack para acessar essas informações do Slack ou criar um lembrete para informá-lo quando o uso diário de largura de banda, CPU ou memória ultrapassar um determinado limite.
Acesse usuários da empresa com a API da Kinsta
Em resposta às solicitações dos clientes, adicionamos um endpoint para recuperar detalhes sobre os usuários da empresa da conta Kinsta, incluindo seu nome completo, e-mail e URL da imagem gravatar.
Isso se alinha ao nosso compromisso de priorizar recursos com base no feedback do usuário. Se você acredita que uma ferramenta ou endpoint específico deve ser incluído na API da Kinsta, sinta-se à vontade para enviar seu feedback.
Para acessar esses dados, envie uma solicitação GET para: https://api.kinsta.com/v2/company/{company_id}/users. Certifique-se de substituir {company_id} pelo ID da sua empresa. Isso retornará uma resposta como:
{
"company": {
"users": [
{
"user": {
"id": "54fb80af-576c-4fdc-ba4f-b596c83f15a1",
"email": "[email protected]",
"image": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
"full_name": "John Doe"
}
}
]
}
}Comece a usar a API da Kinsta hoje mesmo
Para usar a API da Kinsta, você precisa de uma conta Kinsta ativa com pelo menos um site, aplicativo ou banco de dados WordPress no MyKinsta. Veja como gerar uma chave API:
- Vá para o seu painel MyKinsta.
- Navegue até a página Chaves API (Seu nome > Configurações da empresa > Chaves API).
- Clique em Criar chave API.
- Escolha uma data de expiração ou defina uma data de início personalizada e o número de horas para a chave expirar.
- Dê à chave um nome exclusivo.
- Clique em Gerar.
Quando a chave API for criada, certifique-se de copiá-la e armazená-la em algum lugar seguro, pois essa é a única vez que você poderá vê-la. Recomendamos que você use um gerenciador de senhas como o 1Password para compartilhá-la com segurança.
Há muitas coisas que você pode fazer com a API da Kinsta. Sinta-se à vontade para consultar nossa documentação para entender o que é possível fazer com a API, como começar e os vários níveis de permissão e limites da API.
Você também pode conferir nossos changelogs anteriores da API da Kinsta:
- Apresentando a API da Kinsta: O poder da automação para o gerenciamento de sites
- Apresentando os novos endpoints da API da Kinsta: CRUD de ambiente, Edge Caching, implantação de aplicativos
- Novos endpoints da API da Kinsta: Limpar cache CDN e mover ambiente
- Novos endpoints da API da Kinsta aprimoram o gerenciamento do site WordPress
- 3 novos endpoints da API da Kinsta para hospedagem de aplicativos (CDN, Edge Caching e limpeza de cache)