Coletar análises para uma API

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

    • Selecione para quais APIs as análises serão coletadas e selecione se as informações do solicitante devem ser coletadas para cada API.

    Antes de Iniciar

    Nota:
    A análise de API não está disponível para determinadas APIs usadas para funcionalidade da plataforma interna, como a IU e as APIs do aplicativo para celular.
    Função necessária: api_analytics_read ou admin

    Por Que e Quando Desempenhar Esta Tarefa

    Quando uma nova API é adicionada, um registro de lista de inclusões é criado automaticamente. Você pode modificar ou criar novos registros de lista de inclusões para configurar manualmente quais APIs e informações do solicitante são registradas em log.

    Procedimento

    Navegar até Todos > Serviços web do sistema > Lista de inclusões e crie um novo registro.
    Tabela 1. Campos de listas de inclusões de estatísticas de transações de API
    Campo Descrição
    Nome da API Para REST APIs, insira o nome da API. Este nome deve conter somente o namespace e o ID da API. Não inclua parâmetros de solicitação no nome da API.

    Por exemplo, para os endpoints da API da tabela api/now/table/incident e api/now/table/problem, o namespace e o ID são now/table.

    As SOAP APIs não oferecem suporte a configurações de registro em log separadas para diferentes APIs. Você pode configurar o registro em log para todas as SOAP APIs modificando o registro da lista de inclusões de SOAP APIs.
    Coletar estatísticas de API Marque esta caixa de seleção para rastrear análises da API especificada.
    Coletar estatísticas do solicitante da API Marque esta caixa de seleção para rastrear quais usuários fazem solicitações a esta API. Esta opção estará disponível somente se Coletar estatísticas de API estiver selecionado.