Method: domains.domainStats.query

Recupera uma lista de estatísticas de domínio para um domínio e período específicos. Retorna PERMISSION_DENIED se você não tiver permissão para acessar DomainStats do domínio.

Solicitação HTTP

POST https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/domainStats:query

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso principal em que as estatísticas são consultadas. Formato: domains/{domain}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campos
metricDefinitions[]

object (MetricDefinition)

Obrigatório. As métricas específicas a serem consultadas. Você pode definir um nome personalizado para cada métrica, que será usado na resposta.
timeQuery

object (TimeQuery)

Obrigatório. O período ou as datas específicas em que as métricas serão recuperadas.
pageSize

integer

Opcional. O número máximo de recursos DomainStats a serem retornados na resposta. O servidor pode retornar menos que esse valor. Se não for especificado, um valor padrão de 10 será usado. O valor máximo é 200.
pageToken

string

Opcional. O valor nextPageToken retornado de uma solicitação de lista anterior, se houver. Se a granularidade de agregação for DIÁRIA, o token de página será a data codificada + "/" + nome da métrica. Se a granularidade de agregação for "OVERALL", o token da página será o nome da métrica codificado.
aggregationGranularity

enum (AggregationGranularity)

Opcional. A granularidade em que as estatísticas serão agregadas. Se não for especificado, o padrão será DIÁRIO.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de QueryDomainStatsResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Para mais informações, consulte o guia de autorização.