Cato Ler Apenas API - appStats

Visão geral do appStats

A API appStats é baseada na tela Analytics da Aplicação e fornece dados agregados de rede ao longo de um intervalo de tempo por fonte, destino, aplicativo, e assim por diante.

Cada consulta calcula a agregação sobre diferentes medidas (bytes enviados, bytes recebidos, número de fluxos, etc...) dada uma certa função de agregação (soma, máximo, média, etc...) e diferentes dimensões (nome_do_site, usuário, aplicativo, etc...)

Exemplos de uso da consulta appStats:

• Calcular total/média/máximo de largura de banda de um site específico

• Máximo número de fluxos gerados para um destino específico

• Os 10 aplicativos mais usados por um determinado host

Argumentos para appStats

Estes são os argumentos que você pode passar e definir os dados que são retornados pela consulta (todos os campos são obrigatórios):

• IDs de contas

• medidas

• filtros

• dimensão

• ordenar

• intervalo de tempo

Argumento appStats ID da Conta

Insira um ou mais IDs de contas para os dados que a consulta retorna.

Este ID da Conta não é mostrado no Aplicativo de Gerenciamento Cato, em vez disso, é o número na URL para o Aplicativo de Gerenciamento Cato. Por exemplo, o ID da Conta é 26 para a seguinte URL: https://cc.catonetworks.com/#!/26/topologia.

Argumento appStats filtros

O argumento filtros permite definir os dados específicos que são incluídos na consulta. Estes são os argumentos que você pode definir:

• fieldName - define o Tipo de campo que você deseja Filtrar (para mais informações, consulte abaixo Campos appStats)

• operator - define como Ativar os Valores para Filtrar os Dados (para mais informações, consulte abaixo Operador de Filtro appStats)

• valores - define o valor do filtro que é usado com o operador

A seguinte sintaxe de filtros é um exemplo de uma consulta que é filtrada para mostrar dados para uma aplicação específica:

"filters": [
    {
        "fieldName": "aplicação",
        "operator": "é",
        "values": [
            "Slack"
        ]
    }
]

Argumento appStats dimensões

Use o argumento dimensões para agrupar campos com os mesmos valores em linhas resumidas.

O exemplo a seguir agrupa os campos de acordo com os nomes dos sites:

"dimensions": [
    {
        "fieldName": "site_name"
    }
]

Argumento appStats medidas

O argumento medidas permite definir os campos que você deseja que a consulta retorne e seu tipo de agregação. Estes são os argumentos que você pode definir:

• fieldName - define o Tipo de campo que você deseja Filtrar (para mais informações, consulte abaixo Campos appStats)

• aggType - define o Tipo de agregação (para mais informações, consulte abaixo Agregação appStats)

O exemplo a seguir mostra a sintaxe de medidas para uma consulta que mede o resumo dos fluxos criados para o aplicativo Slack:

"filters": [
    {
        "fieldName": "aplicação",
        "operator": "é",
        "values": [
            "Slack"
        ]
    }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    }
]

Argumento appStats classificação

O argumento classificação define como os dados são classificados.

O exemplo a seguir mostra a sintaxe de classificação para uma consulta que mede o resumo dos fluxos criados para o aplicativo Slack. Em seguida, classifica os dados em ordem decrescente de fluxos criados:

"filters": [
    {
        "fieldName": "aplicação",
        "operator": "é",
        "values": [
            "Slack"
        ]
    }
]
"measures": [
    {
        "fieldName": "flows_created",
        "aggType": "sum"
    }
]
"sort": [
    {
        "fieldName": "flows_created",
        "order": "desc"
    }
]

Argumento appStarts intervalo de tempo

Define o período de tempo da consulta.

"intervalo de tempo": "últimos.P2D"

Consulta de exemplo appStats

Este é um exemplo de uso da consulta API appStats para retornar a soma de fluxos criados para o aplicativo Slack para cada site ao longo do período de tempo dos últimos dois dias. Os dados são classificados em ordem decrescente para os cinco principais sites.

Exemplo de consulta

consulta appStats($accountID: ID!, $medidas: [Medida], $dimensões: [Dimensão], $filtros: [AppStatsFiltro!], $classificação: [AppStatsClassificação!], $intervalo de tempo: Intervalo de Tempo!, $limite: Int, $de: Int) {
  appStats(
    accountID: $accountID
    timeFrame: $intervalo de tempo
    medidas: $medidas
    dimensões: $dimensões
    filtros: $filtros
    classificação: $classificação
  ) {
    id
    records(limite: $limite, de: $de) {
      fieldsUnitTypes
      fieldsMap
      trends
    }
  }
}

Valores das Variáveis

{
  "accountID": "1234",
  "dimensões": [
    {
      "fieldName": "site_name"
    }
  ],
  "medidas": [
    {
      "fieldName": "flows_created",
      "aggType": "sum"
    }
  ],
"filters": [
    {
        "fieldName": "aplicação",
        "operator": "é",
        "values": [
            "Slack"
        ]
    }
]
  "classificação": [
    {
      "fieldName": "flows_created",
      "order": "desc"
    }
  ],
  "intervalo de tempo": "últimos.P2D",
  "limite": 5,
  "de": 0
}

Saída de Exemplo AppStats

{
  "dados": {
    "appStats": {
      "id": "1234",
      "registros": [
        {
          "fieldsMap": {
            "flows_created": "116660",
            "site_name": "Sample Socket"
          }
        },
        {
          "fieldsMap": {
            "flows_created": "105655",
            "site_name": "Sample Socket 2"
          }
        }
      ]
    }
  }
}

Campos appStats

Esta é uma descrição dos campos nas consultas de appStats.

agregação de appStats

Estes são os Valores para o appStats aggType:

• soma

• contagem

• contagem_distinta

• distinto

• média

• max

• min

• qualquer

appStats filterOperator

Estes são os valores para o appStats filterOperator:

• é

• não_é

• em

• não_em

• existe

• não_existe

• entre

• não_entre

• maior_que

• maior ou igual

• menor_que

• menor ou igual