Visão geral da consulta da API de eventos
A consulta da API de eventos fornece uma maneira de obter informações resumidas sobre os eventos gerados para uma conta sem precisar extrair os eventos individuais e realizar a análise.
Exemplos do tipo de análise incluído na API de eventos:
Número de usuários SDP que fizeram login durante um período específico
Percentual de eventos de bloqueio vs. autorização do firewall
Mostrar quantos eventos (cardinalidade) foram gerados para cada tipo de evento nos últimos 30 dias
Argumentos para eventos
Estes são os argumentos que você pode passar para a chamada da API de eventos para modificar sua operação:
ID da Conta
medidas
filtros
dimensões
ordenar
período de tempo
O argumento ID da Conta
Este é o ID da Conta para a conta sobre a qual você está executando a consulta.
Nota:
Este ID da Conta não é mostrado na Aplicação de Gerenciamento Cato; em vez disso, é o número na URL da Aplicação de Gerenciamento Cato. Por exemplo, o ID da Conta é 26 para a seguinte URL: https://cc.catonetworks.com/#!/26/topologia.
O argumento medidas
O argumento medidas permite definir os campos que você deseja que a consulta eventos examine e a maneira como os resultados devem ser agregados. Para cada campo que você deseja analisar, você deve definir o seguinte:
nome do campo - define o campo que você deseja agregar
tipo de agregação - define como você deseja que a agregação seja realizada (ex: contagem distinta)
O seguinte exemplo mostra a sintaxe de medidas para uma consulta que retorna a soma dos campos event_count:
"medidas": [
{"nome do campo":"event_count","tipo de agregação":"soma"}
]O argumento filtros
O argumento filtros permite definir um filtro que resultará em apenas um subconjunto limitado de eventos sendo examinado. Para cada filtro, você deve definir o seguinte:
nome do campo - define o nome do campo que você deseja filtrar
operador - define a operação de filtro que deve ser usada para filtrar o campo
valores - define o valor do filtro que é usado com o operador
Aqui está um exemplo do argumento filtros usado para selecionar apenas eventos com event_type como Segurança:
"filtros": [
{
"nome do campo": "event_type",
"operador": "é",
"valores": ["Segurança"]
}
]O argumento dimensões
Use o argumento dimensões para agrupar campos com os mesmos valores em linhas resumidas.
Aqui está um exemplo que agrupa os arquivos de acordo com o event_type:
"dimensões": [
{"nome do campo": "event_type"}
]O argumento ordenar
O argumento ordenar define como os dados retornados devem ser ordenados. Aqui está um exemplo de uso do argumento ordenar
'ordenar': [
{'nome do campo': 'event_count', 'ordem': 'desc'},
{'nome do campo': 'event_type', 'ordem': 'asc'}
]O argumento período de tempo
Define o período de tempo da consulta. Isto é especificado usando o formato definido pela especificação ISO 8601. Aqui está um exemplo de como você especificaria o período de tempo para os últimos 30 dias:
"período de tempo": "last.P30D" Notas:
O tempo máximo que pode ser especificado para o argumento período de tempo é atualmente de 89 dias.
A especificação ISO 8601 real pode ser obtida aqui, mas não é gratuita. Você também pode consultar este artigo da Wikipedia para mais informações sobre como entender este argumento.
Exemplo de consulta de eventos
Exemplo de consulta
query events(
$accountID: ID!,
$measures: [EventsMeasure],
$dimensions: [EventsDimension],
$filters: [EventsFilter!],
$sort: [EventsSort!],
$timeFrame: TimeFrame!,
$limit: Int,
$from: Int) {
events(
accountID: $accountID
timeFrame: $timeFrame
measures: $measures
dimensions: $dimensions
filters: $filters
sort: $sort ) {
id
from
total
records(limit: $limit, from: $from) {
fieldsMap
}
}
}Valores das Variáveis
{
"accountID": "1234",
"medidas": [ {
"nome do campo": "event_sub_type",
"tipo de agregação": "contagem_distinta"
}
],
"filtros": [ {
"nome do campo": "event_type",
"operador": "é", "valores": ["Segurança"]
}
],
"períodoDeTempo": "last.P1M"
}Exemplo de saída de eventos
{
"dados": {
"eventos": {
"id": "xxx",
"de": "2023-01-26T00:00:00Z",
"para": "2023-02-27T00:00:00Z",
"total": 1,
"registros": [
{
"mapeamentoDeCampos": {
"event_sub_type": "6"
}
}
]
}
}
}