Painel de uso da API

O dashboard de uso da API permite monitorar o tráfego de entrada da API REST na Braze para entender as tendências de uso de nossas APIs REST e solucionar possíveis problemas.

Sobre o dashboard de uso da API

Para visualizar o painel de uso da API, acesse Configurações > APIs e identificadores e selecione Dashboard.

O dashboard padrão é uma visualização de todas as solicitações de entrada da API REST para seu espaço de trabalho no último dia (24 horas). Dependendo do seu caso de uso, é possível ajustar os controles do dashboard para filtrar ou agrupar o tráfego e também configurar o intervalo de tempo do dashboard.

Dashboard de uso da API com 130 solicitações no total, com uma taxa de sucesso de 70% e uma taxa de falha de 30%.

Métricas disponíveis

O dashboard de uso da API inclui as seguintes estatísticas:

Métrico Descrição

Total de solicitações O número total de solicitações enviadas ao Braze para o seu espaço de trabalho atual, considerando os filtros e controles aplicados ao dashboard.

Taxa de sucesso A porcentagem do total de solicitações em que o Braze emitiu uma resposta de sucesso 2XX.

Taxa de erros A porcentagem do total de solicitações em que o Braze emitiu uma resposta de erro 4XX ou 5XX.

Usando o dashboard

Filtros a serem aplicados ao dashboard, incluindo: Chave de API, ponto de extremidade, códigos de resposta, dados de grupo e data.

Filtros

Selecione Filtros para aplicar filtros e restringir a visualização do tráfego da API REST para seu espaço de trabalho, incluindo:

Chave de API
Endpoint
Código da resposta

Agrupar dados

Você pode agrupar dados em várias séries de dados para explorar diferentes padrões em seu uso, inclusive:

Códigos de resposta (padrão)
Endpoint de API
Chave de API
Somente sucesso e falha

Data

Ajuste o filtro de data para mostrar um intervalo de tempo maior ou menor, conforme necessário. Isso inclui:

Hoje (padrão)
Personalizado
Últimas 3 horas
Últimas 6 horas
Últimas 12 horas
Últimas 24 horas
Ontem
Últimos 7 dias
Últimos 14 dias
Últimos 30 dias
Último mês até a data

note:

As opções Últimas 3 horas e Últimas 6 horas mostrarão o tráfego por minutos. Períodos de tempo maiores mostrarão o tráfego a cada cinco minutos, hora ou dia.

Considerações

O dashboard de uso da API inclui todas as solicitações da API REST que a Braze recebeu e para as quais retornou uma resposta 2XX, 4XX ou 5XX. Isso inclui saídas de transformação de dados e sincronizações de ingestão de dados na nuvem. As etapas de tráfego do SDK e de atualização do usuário não estão incluídas nesse dashboard.

Os dados mostrados no dashboard podem ter até uma pequena postergação na exibição do tráfego recente. Durante períodos de alta utilização, você pode atualizar o dashboard até 4 vezes por minuto. Talvez seja necessário aguardar alguns minutos antes de atualizar o dashboard novamente.