Dashboard de uso da API
O dashboard de uso da API permite monitorar o tráfego de entrada da REST API na Braze para entender as tendências de uso das nossas REST APIs e solucionar possíveis problemas.
Sobre o dashboard de uso da API
Para visualizar seu dashboard de uso da API, acesse Configurações > APIs e identificadores e selecione Dashboard.
O dashboard padrão mostra todas as solicitações REST API recebidas pelo seu espaço de trabalho no último dia (24 horas). Dependendo do seu caso de uso, você pode ajustar os controles do dashboard para filtrar ou agrupar o tráfego e também configurar o intervalo de tempo do dashboard.

Métricas disponíveis
O dashboard de uso da API inclui as seguintes estatísticas:
| Métrica | Descrição |
|---|---|
| Total de solicitações | O número total de solicitações enviadas à Braze para 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 a Braze emitiu uma resposta de sucesso 2XX. |
| Taxa de erro | A porcentagem do total de solicitações em que a Braze emitiu uma resposta de erro 4XX ou 5XX. |
Uso do dashboard

Filtros
Selecione Filtros para aplicar filtros e restringir a visualização do tráfego da REST API no seu espaço de trabalho, incluindo:
- Chave de API
- Endpoint
- Código de resposta
Agrupar dados
Você pode agrupar os dados em várias séries para explorar diferentes padrões no seu uso, incluindo:
- Códigos de resposta (padrão)
- Endpoint da API
- Chave de API
- Somente sucesso e falha
Data
Ajuste o filtro de data para mostrar um intervalo de tempo menor ou maior, conforme necessário. As opções incluem:
- 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 atual

As opções Últimas 3 horas e Últimas 6 horas mostram o tráfego por minuto. Períodos maiores mostram o tráfego a cada cinco minutos, hora ou dia.
Visualização dos registros de solicitações
Para ver as solicitações individuais por trás de um ponto no gráfico, selecione um ponto de dados e depois Visualizar registros de solicitações. O registro de solicitações da API é aberto com o intervalo de tempo desse ponto de dados e com os filtros de endpoint, código de resposta e chave de API aplicados ao gráfico.
Os registros de solicitações estão disponíveis apenas para o tráfego da REST API dos últimos 14 dias.
Considerações
O dashboard de uso da API inclui todas as solicitações da REST API que a Braze recebeu e para as quais retornou uma resposta 2XX, 4XX ou 5XX. Isso inclui as saídas da Transformação de Dados e as sincronizações da Ingestão de Dados na Nuvem. O tráfego do SDK e as etapas de Atualização de Usuário não estão incluídos neste dashboard.
Os dados mostrados no dashboard podem ter uma breve postergação na exibição do tráfego recente. Em períodos de alto uso, você pode atualizar o dashboard até 4 vezes por minuto. Talvez seja necessário aguardar alguns minutos antes de atualizar o dashboard novamente.
Chaves de API no corpo da solicitação
Quando as chaves de API são enviadas no corpo da solicitação em vez do cabeçalho da solicitação, algumas solicitações podem não aparecer no dashboard de uso da API. Isso pode gerar dados incompletos no dashboard e dificultar o monitoramento preciso do uso da API.
Para ter relatórios mais precisos no dashboard de uso da API, inclua as chaves de API no cabeçalho da solicitação em vez de no corpo da solicitação.