Documentação Técnica

Estatísticas de Envios

Este endpoint permite consultar o métricas de envio das chamadas assíncronas, retornando o tempo médio de envio (geral e por dataset), a quantidade pendente e os totais de envios bem-sucedidos e com falha. A consulta é, por padrão, limitada à conta do usuário do token, com a opção de ser expandida para o domínio completo.

Parâmetros de Entrada

A tabela abaixo detalha os campos aceitos na consulta a este serviço.

CampoDescrição
SearchByDomainOpcional. Define o escopo da busca. Se true, a consulta é feita pelo Domínio do usuário. Se false ou omitido, é feita pelo Usuário.
DatasetsOpcional. String com um ou mais datasets, separados por vírgula (ex: 'basic_data,processes''). Se fornecido, filtra os resultados de AverageTimeByDataset. Se omitido, retorna todos os datasets para o escopo.

Retorno

A tabela a seguir descreve os campos do objeto de retorno deste método.

CampoTipoDescrição
SearchScopestringO identificador usado na busca (o nome do Domínio ou do Usuário).
OverallAverageDispatchTimeInMillisecondsdoubleO tempo médio geral de envio para o escopo buscado, em milisseguntos.
TotalPendingHooksintA quantidade total de hooks pendentes encontrados.
TotalDispatchedHooksInLastHourintA quantidade total de hooks despachados com sucesso na a última hora.
TotalErrorHooksInLastHourintA quantidade total de hooks que resultaram em erro na última hora.
AverageTimeByDatasetInMillisecondsDicionário (string: double)Detalhamento do tempo médio de envio para cada dataset. A chave é o nome do dataset e o valor é a média em milisseguntos.
Language
Credentials
Click Try It! to start a request and see the response here!