Sign up for email announcements to stay updated on the latest information about the GMB API.

BasicMetricsRequest

A request for basic metric insights.

JSON representation
{
  "metricRequests": [
    {
      object (MetricRequest)
    }
  ],
  "timeRange": {
    object (TimeRange)
  }
}
Fields
metricRequests[]

object (MetricRequest)

A collection of metrics to return values for including the options for how the data should be returned.

timeRange

object (TimeRange)

The range to gather metrics for. The maximum range is 18 months from the request date. In some cases, the data may still be missing for days close to the request date. Missing data will be specified in the metricValues in the response.

MetricRequest

A request to return values for one metric and the options for how those values should be returned.

JSON representation
{
  "metric": enum (Metric),
  "options": [
    enum (MetricOption)
  ]
}
Fields
metric

enum (Metric)

The requested metric.

options[]

enum (MetricOption)

How the values should appear when returned.