Method: domains.domainStats.query

Recupera una lista de estadísticas del dominio para un dominio y un período determinados. Devuelve PERMISSION_DENIED si no tienes permiso para acceder a DomainStats del dominio.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso principal en el que se consultan las estadísticas. Formato: domains/{domain}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Campos
metricDefinitions[]

object (MetricDefinition)

Obligatorio. Son las métricas específicas que se consultarán. Puedes definir un nombre personalizado para cada métrica, que se usará en la respuesta.
timeQuery

object (TimeQuery)

Obligatorio. Es el período o las fechas específicas para los que se recuperarán las métricas.
pageSize

integer

Opcional. Es la cantidad máxima de recursos de DomainStats que se devolverán en la respuesta. Es posible que el servidor devuelva menos que este valor. Si no se especifica, se usará un valor predeterminado de 10. El valor máximo es 200.
pageToken

string

Opcional. El valor nextPageToken que se muestra de una solicitud de lista previa, si existe. Si el nivel de detalle de la agregación es DIARIO, el token de página será la fecha codificada + "/" + el nombre de la métrica. Si el nivel de detalle de la agregación es OVERALL, el token de página será el nombre de la métrica codificado.
aggregationGranularity

enum (AggregationGranularity)

Opcional. Es la granularidad con la que se agregan las estadísticas. Si no se especifica, el valor predeterminado es DAILY.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de QueryDomainStatsResponse.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.