post
https://plataforma.bigdatacorp.com.br/monitoramento/relatorio
Descrição
Esta funcionalidade permite verificar o histórico de envios de monitoramento, bem como os datasets monitorados. São retornadas informações paginadas sobre cada monitoramento e o número de documentos alterados.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não.
| Campo | Obrigatório? | Descrição | Valores Possíveis |
|---|---|---|---|
| AccessToken | Sim | Token de autenticação nas APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição. | Token JWT |
| Limit | Não | Indica a quantidade de retornos por página | 10,20,30... |
| PageId | Não | Indica o número da página a ser consultada | 1,2,3 |
| OrderByDescendingDate | Não | Indica a ordem dos items da lista. Por padrão a ordem é decrescente. | Boolean |
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| SubscriptionDeliveries | Lista de objetos com o histórico de monitoramentos |
| SubscriptionDeliveries[n].TotalRecords | Quantidade de documentos monitorados |
| SubscriptionDeliveries[n].TriggeredRecords | Quantidade de documentos que ativaram o monitoramento |
| SubscriptionDeliveries[n].DeliveryDate | Data de envio do monitoramento |
| SubscriptionDeliveries[n].TriggeredSummary | Objeto com detalhes do monitoramento |
| SubscriptionDeliveries[n].TriggeredSummary[n].Api | Api monitorada |
| SubscriptionDeliveries[n].TriggeredSummary[n].Datasets | Datasets inscritos no monitoramento |
| SubscriptionDeliveries[n].TriggeredSummary[n].Datasets[n].TotalTriggeredRecords | Quantidade de documentos que ativaram o monitoramento |
| SubscriptionDeliveries[n].TriggeredSummary[n].Datasets[n].TriggeredPercentage | Porcentagem de documentos que ativaram o monitoramento em relação aos documentos monitorados |
| SubscriptionDetails[n].LastTriggeredDate | Data em que a última alteração foi encontrada |
Exemplo de Chamada
A seguir estão alguns exemplos de uso deste endpoint.
{
"AccessToken": "<YOUR_ACCESS_TOKEN>"
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"OrderByDescendingDate": false
}
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"PageId": 4,
"Limit": 1,
}