Method: accounts.locations.localPosts.reportInsights

  • Returns insights data for a set of local posts associated with a single listing, limited to 100 posts per API call.

  • The request body specifies the local post names and includes an optional request for basic metric insights.

  • The response provides metrics for each requested post, along with the location's time zone.

  • Requires authorization with either https://www.googleapis.com/auth/plus.business.manage or https://www.googleapis.com/auth/business.manage scope.

Returns insights for a set of local posts associated with a single listing. Which metrics and how they are reported are options specified in the request proto.

HTTP request

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}/localPosts:reportInsights

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the location for which to fetch insights.

Request body

The request body contains data with the following structure:

JSON representation
{
  "localPostNames": [
    string
  ],
  "basicRequest": {
    object (BasicMetricsRequest)
  }
}
Fields
localPostNames[]

string

Required. The list of posts for which to fetch insights data. All posts have to belong to the location whose name is specified in the name field.

basicRequest

object (BasicMetricsRequest)

A request to include basic metric insights in the report. This request applies to all posts requested.

Response body

If successful, the response body contains data with the following structure:

Response message for Insights.ReportLocalPostInsights

JSON representation
{
  "name": string,
  "localPostMetrics": [
    {
      object (LocalPostMetrics)
    }
  ],
  "timeZone": string
}
Fields
name

string

localPostMetrics[]

object (LocalPostMetrics)

One entry per requested post corresponding to this location.

timeZone

string

Time zone (IANA timezone IDs, eg, 'Europe/London') of the location.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

LocalPostMetrics

All the metrics requested for a Local Post.

JSON representation
{
  "localPostName": string,
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
Fields
localPostName

string

metricValues[]

object (MetricValue)

A list of values for the requested metrics.