Como obter respostas do antigo api-metrics usando a Analytics API

  • O contrato da API que substitui o api-metrics é diferente.

  • O endereço base (Base URL) e o método de autenticação variam de acordo com a versão da plataforma Sensedia que você utiliza.
Versão Base URL Autenticação

v.5 (Sensedia Platform)

https://platform-production.sensedia.com

Header Authorization com o valor do access-token.

v.4

Sua Base URL personalizada

Header sensedia-auth com o valor da chave de acesso.

Em relação ao Analytics quando acoplado à plataforma, a versão atual oferece maior flexibilidade, permitindo personalizar consultas com muito mais granularidade.

Para isso, disponibilizamos o endpoint {/analytics/v1/products/api-gateway/traces/query}, que substitui o api-metrics.

Veja um exemplo de uso:

Obtendo o total de chamadas do dia com o endpoint traces/query

Se preferir, acompanhe os passos com o vídeo 1 no final da página.

  1. Na ferramenta da sua escolha (e.g., Postman), selecione o método POST e informe a sua URL com o endpoint {/analytics/v1/products/api-gateway/traces/query}.

  2. Em Headers, configure a autenticação conforme a sua versão:

    • v.4: informe a chave sensedia-auth. Veja aqui como obter esse valor.

    • v.5: informe a chave Authorization e, no valor, insira o seu access-token.

      Na v.5, você pode obter o access-token através do cookie de mesmo nome no seu navegador após realizar o login no Sensedia Platform.

      imagem do postman destacando campos de interesse para o passo 2

  3. Escreva a sua busca no corpo da requisição.
    Você pode usar DQL ou Lucene.
    Veja mais abaixo dicas de como obter a query pronta, seja a partir de um filtro do General Trace ou de uma visualização do Dashboard.
    imagem do postman destacando campos de interesse para o passo 3

  4. Clique em SEND e veja o resultado no corpo da resposta.
    imagem do postman destacando campos de interesse para o passo 4


Aqui vão algumas dicas para economizar seu tempo.

Você pode montar a busca usando a interface gráfica e depois copiar a query resultante e colar no passo 3 acima.

Monte a sua query a partir da interface gráfica do Analytics usando filtros do General Trace ou visualizações do Dashboard. Veja abaixo como.

As consultas feitas pelo endpoint /traces/query possuem limitações de uso, como timeout e rate limit. Elas são indicadas apenas para consultas pontuais. Para uma extração dos dados mais completa, utilize o Data Streaming.

Filtros do General Trace

Siga os passos do exemplo abaixo para gerar uma query a partir da interface gráfica do General Trace.

Os passos podem ser usados com qualquer combinação de filtros, definidos no passo 1 a seguir.

Exemplo de "atalho" para escrever uma query usando o General Trace

Se preferir, acompanhe os passos com o vídeo 2 no final da página.

  1. No Analytics, em General Trace, crie uma busca usando os filtros disponíveis.
    Para este exemplo, vamos definir um filtro por status code e um intervalo de tempo de 1 semana, como ilustrado na imagem abaixo. imagem do general trace destacando filtros usados

  2. Uma vez criados os filtros, clique em Inspect.
    imagem do general trace destacando o link inspect

  3. Clique em Request e procure pela query.
    imagem do general trace destacando o link request

  4. Selecione e copie a query do Inspect > Request do General Trace.

  5. Esta query é usada no passo 3 do primeiro exemplo, isto é:

    1. Vá para o Postman e cole a query no local apropriado dentro campo Body da requisição.
      Atente-se para o início e fim das chaves.
      imagem das telas do general trace e postman destacando query para copiar e colar

    2. Ainda no Postman, clique em SEND e confira o resultado no corpo da resposta.

Agregações do Visualize ou Dashboards

Siga os passos do exemplo abaixo para gerar uma query a partir da interface gráfica do Dashboard ou Visualize.

Os passos podem ser usados com qualquer gráfico.

Você pode adequar a busca para trazer o que precisa, utilizando os recursos do Visualize ou Dashboards.

Exemplo de "atalho" para escrever uma query com agregação usando o Dashboards

Se preferir, acompanhe os passos com o vídeo 3 no final da página.

  1. No Analytics, entre em Dashboards.

  2. Na lista com seus Dashboards, procure e abra o Dashboard que contém a visualização com a agregação que deseja.

  3. Clique no ícone no canto superior direito do painel que contém a visualização escolhida e clique em More > Inspect.
    Em seguida, clique em View:Data > Requests > Request e copie toda a query.

    animação mostrando o link inspect depois requests depois request e ícone para copiar a query

  4. Vá para o Postman e cole a query no campo Body da requisição.

  5. Ainda no Postman, clique em SEND e confira o resultado no corpo da resposta.

    animação com os passos 4 e 5

Link útil

Para buscas mais simples, você pode escrever a query diretamente no passo 3 do primeiro exemplo.

Consulte a página sobre Query DSL na documentação do OpenSearch para exemplos de queries básicas.

Dicas rápidas em vídeo

Veja em vídeos os mesmos passos informados acima.

1. Endpoint traces/query

2. Query com General Trace

3. Query com Dashboards

video1 thumbnail

video2 thumbnail

video3 thumbnail
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]