Painéis de análise de REST & SOAP API

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 1 min. de leitura

    • Você pode exibir a análise de API para a instância inteira ou para APIs específicas usando os painéis incluídos.

    O REST & SOAP API Analytics inclui painéis que apresentam as análises gerais, análises por API e análises por usuário solicitante.

    Para acessar os painéis de Análise de API, navegue até Serviços Web do sistema e selecione Visão geralde uso, Uso por APIou Uso por solicitante. Usuários com as funções api_analytics_read ou admin podem exibir esses painéis.
    Nota:
    O painel Uso pelo solicitante usa o recurso Tela responsiva disponível com Istanbul. Para obter a melhor experiência em instâncias atualizadas, talvez seja necessário habilitar painéis dinâmicos.
    Os seguintes painéis estão disponíveis:
    Tabela 1. Painéis de análise de API disponíveis
    Painel Descrição
    Visão geral de uso Fornece estatísticas gerais de uso para todas as APIs REST e SOAP.
    Uso por API da web Fornece estatísticas de uso detalhadas para cada API.
    Uso pelo Solicitante Fornece estatísticas de uso detalhadas para cada usuário solicitante.

    Você também pode filtrar por API para exibir estatísticas detalhadas de um usuário específico e combinação de API. Se o usuário selecionado não tiver feito solicitações à API selecionada, nenhum dado será mostrado para essa combinação.

    Nota:
    Para exibir as estatísticas de API de todos os usuários, não desmarque a seleção de detalhamento do usuário. Em vez disso, use o painel Uso por API da web.

    Você pode acessar a análise de API no Explorador de REST API. Ao explorar uma API, clique no ícone do menu de contexto ( ícone do menu de contexto) e selecione Análise de API para exibir as análises dessa API específica.

    Para serviços Web personalizados, como REST APIs de script ou serviços Web SOAP de script, você pode acessar a análise da API clicando no link relacionado à análise de API nos formulários do Serviço REST de script ou do Serviço Web de script.

    Quando você acessa diretamente a análise de uma API, se não houver análises para essa API específica, a análise de todas as APIs será exibida.