1 of 20
2 of 20
3 of 20
4 of 20
5 of 20
6 of 20
7 of 20
8 of 20
9 of 20
10 of 20
11 of 20
12 of 20
13 of 20
14 of 20
15 of 20
16 of 20
17 of 20
18 of 20
19 of 20
20 of 20

doc

Como realizar consultas de queries Top X com a API GraphQL

As queries Top X costumam ser utilizadas para realizar consultas e análises sobre dados. Elas têm a finalidade de visualizar a utilização de recursos e ferramentas e ter uma visão sobre determinadas condições que são mais ou menos utilizadas.

Para realizar uma consulta de Top X queries através da API GraphQL, você irá realizar duas etapas: criar um Personal Token e executar sua solicitação no Postman. Veja as próximas seções e siga os passos.

  1. Criar Personal Tokens
  2. Consultar dados Top X com o Postman

Criar Personal Tokens

Para começar a usar a API GraphQL, você precisa de um Personal Token a fim de validar seu acesso.

Para criar um Personal Token:

  1. No Real-Time Manager (RTM), selecione Account Menu > Personal Tokens.
  2. Clique no botão Add Personal Token e preencha os campos.
  3. Salve seu Personal Token em um local seguro para utilizá-lo nas próximas etapas.

Veja a página de documentação para mais informações sobre o processo de criação de Personal Tokens.

Como alternativa, você pode criar um Personal Token de curta duração através da Azion API.

Consulta de dados Top X com o Postman

Após criar o seu Personal Token, vá para o Postman e siga os próximos passos:

  1. Na parte superior do Postman, clique no botão com o símbolo de + para criar um nova requisição.
  2. Vá até a aba Headers, na parte superior, clique em Bulk Edit e adicione o seguinte código, juntamente com o valor do Personal Token que foi criado:
Authorization:Token [TOKEN VALUE]

Após criar o Headers com o token, siga na mesma tela do Postman para criar o corpo da requisição:

  1. No canto superior esquerdo, clique na opção GET para abrir a lista suspensa.
  2. Selecione a opção POST.
  3. Vá até a aba Body, na linha de opções, e selecione GraphQL.
  4. No espaço QUERY, adicione a seguinte Top X Query:
query EventsTopUri {
 httpEvents(
   limit: 5,
   filter: {
     tsRange: {begin:"2022-11-20T10:10:10", end:"2022-11-27T10:10:10"}
   },
   aggregate: {count: requestUri}
   groupBy: [requestUri]
   orderBy: [count_DESC]
   )
 {
   requestUri
   count
 }
}

O exemplo acima consulta o app Events de dados brutos com o dataset de HTTP. Além disso, o operador count solicita a agregação dos dados com as informações do campo requestUri em um determinado período de tempo, informado através do campo tsRange. O retorno da API também foi limitado a 5 registros através do campo limit.

Por fim, os dados foram agrupados (groupBy) pelo campo requestUri e ordenados (orderBy) pelo retorno do operador count, de forma decrescente (DESC), para que os maiores retornos da agregação sejam exibidos primeiro.

Para consultas agregando dados, como neste exemplo, é obrigatório informar:

  • Um intervalo de tempo para consulta utilizando tsRange ou tsGt + tsLt.
  • Os campos em que deseja agrupar as informações utilizando groupBy.
  • Quais dos dados obtidos na consulta devem ser exibidos. No caso do exemplo apresentado, foram utilizados requestUri e count, onde count é o retorno da agregação de requestUri.

Após criar a consulta, você pode enviá-la para a API GraphQL e receber o retorno dos dados:

  1. No campo Enter request URL, adicione a URL da API GraphQL: https://api.azionapi.net/events/graphql
  2. No canto superior direito da página, clique no botão Send.

Você receberá um retorno com os dados solicitados, como no exemplo a seguir:

{
   "data": {
       "httpEvents": [
           {
               "requestUri": "/requests/images",
               "count": 610081
           },
           {
               "requestUri": "/path/to/file/document",
               "count": 6270
           },
           {
               "requestUri": "/send/stock",
               "count": 3568
           }
       ]
   }
}

A API GraphQL retorna os dados da consulta de Top RequestUri de acordo com a query informada na requisição.

Para saber mais sobre como consultar dados com a API GraphQL, visite a página de documentação.


Não encontrou o que procurava? Abra um ticket.