Method: customers.enterprise.securityInsights.queryUrlVisitsBreakdowns

Retorna resumos de visitas de URL para uma determinada métrica e dimensão de detalhamento.

Solicitação HTTP

GET https://chromemanagement.googleapis.com/v1/{customer=customers/*}/enterprise/securityInsights:queryUrlVisitsBreakdowns

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customer

string

Obrigatório. O ID do cliente no formato "customers/{customer_id}".

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de detalhamentos a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 detalhamentos serão retornados. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.

pageToken

string

Opcional. Um token de página recebido de uma chamada securityInsights.queryUrlVisitsBreakdowns anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para securityInsights.queryUrlVisitsBreakdowns precisam corresponder à chamada que forneceu o token da página.

filter

string

Opcional. O filtro a ser aplicado à solicitação. Para ver a sintaxe, consulte AIP-160. Os dados não estão disponíveis para eventos com mais de 180 dias ou mais recentes que 48 horas atrás. Se event_time não for especificado, os resultados vão terminar 48 horas atrás.

Campos aceitos para filtragem: - user - event_domain - event_time

A filtragem por user ou event_domain exige que a dimensão breakdown seja definida como o valor correspondente (por exemplo, é necessário definir breakdown = USER para filtrar por user).

Operadores aceitos: - = para user e event_domain. - <= para event_time.

Conjunções aceitas: - AND

Exemplo: user = "testuser" AND event_time <= "2024-01-02T00:00:00Z"

metric

enum (UrlVisitsMetric)

Opcional. A métrica para retornar os detalhamentos. O padrão é URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS.

breakdown

enum (UrlVisitsBreakdownDimension)

Opcional. A dimensão para detalhar as visitas de URL. O padrão é USER.

fixedTimeRange

enum (FixedTimeRange)

Opcional. O período fixo para retornar os detalhamentos. O padrão é FIXED_TIME_RANGE_FOUR_WEEKS. Os períodos fixos são usados para permitir a pré-computação e otimizar os tempos de resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para securityInsights.queryUrlVisitsBreakdowns.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "urlVisitsBreakdowns": [
    {
      object (UrlVisitsBreakdown)
    }
  ],
  "nextPageToken": string
}
Campos
urlVisitsBreakdowns[]

object (UrlVisitsBreakdown)

Os detalhamentos de visitas de URL do insight especificado.

nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chrome.management.securityinsights.readonly
  • https://www.googleapis.com/auth/chrome.management.securityinsights

UrlVisitsBreakdownDimension

A dimensão para detalhar as visitas de URL.

Tipos enumerados
URL_VISITS_BREAKDOWN_DIMENSION_UNSPECIFIED Dimensão de detalhamento não especificada. O padrão é USER.
USER Detalhamento por usuário.
EVENT_DOMAIN Detalhamento por domínio de evento.

UrlVisitsBreakdown

Um resumo de visitas de URL para uma determinada dimensão de detalhamento.

Representação JSON
{
  "summary": {
    object (UrlVisitsSummary)
  },

  // Union field dimension can be only one of the following:
  "user": string,
  "eventDomain": string
  // End of list of possible types for union field dimension.
}
Campos
summary

object (UrlVisitsSummary)

O resumo das visitas de URL para a dimensão de detalhamento.

Campo de união dimension. A dimensão do detalhamento. dimension pode ser apenas de um dos tipos a seguir:
user

string

O usuário que acessou o URL.

eventDomain

string

O domínio do evento das visitas de URL.