Method: domains.domainStats.query

Récupère une liste de statistiques de domaine pour un domaine et une période donnés. Renvoie des statistiques uniquement pour les dates pour lesquelles des données sont disponibles. Renvoie PERMISSION_DENIED si vous n'êtes pas autorisé à accéder à DomainStats pour le domaine.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parente pour laquelle les statistiques sont demandées. Format : domains/{domain}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "metricDefinitions": [
    {
      object (MetricDefinition)
    }
  ],
  "timeQuery": {
    object (TimeQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "aggregationGranularity": enum (AggregationGranularity)
}
Champs
metricDefinitions[]

object (MetricDefinition)

Obligatoire. Métriques spécifiques à interroger. Vous pouvez définir un nom personnalisé pour chaque métrique, qui sera utilisé dans la réponse.
timeQuery

object (TimeQuery)

Obligatoire. Plage de dates ou dates spécifiques pour lesquelles récupérer les métriques.
pageSize

integer

Facultatif. Nombre maximal de ressources DomainStats à renvoyer dans la réponse. Le serveur peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, la valeur par défaut de 10 est utilisée. La valeur maximale est de 200.
pageToken

string

Facultatif. La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant. Si la précision de l'agrégation est "DAILY", le jeton de page sera la date encodée + "/" + nom de la métrique. Si la précision de l'agrégation est "OVERALL", le jeton de page correspond au nom de la métrique encodé.
aggregationGranularity

enum (AggregationGranularity)

Facultatif. Précision à laquelle agréger les statistiques. Si aucune valeur n'est spécifiée, la valeur par défaut est "DAILY" (QUOTIDIEN).

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de QueryDomainStatsResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.