Step 2: Update Reports API Endpoints
Here are the steps you can take to successfully migrate your Reports API endpoint calls to use the new metrics.
For each metric below, you will need to update the API name with the new API name, and update the dimensions to ensure they are compatible with the new metric.
Update the GOOGLE_SEARCH_QUERIES Metric
- Find and replace instances of
GOOGLE_SEARCH_QUERIES
with the new API name:LISTINGS_GOOGLE_SEARCH_TERM_IMPRESSIONS
. - Review the dimensions applied to the each metric, and ensure that it is one of the following supported dimensions:
RAW_SEARCH_TERM
MONTHS
ENTITY_IDS
ENTITY_TYPES
ENTITY_LABELS
FOLDER_NAMES
The compatible dimensions for the legacy metrics are different from the compatible dimensions for the new metrics. Visit our Location Listings Metrics documentation for a full list of the supported dimensions per metric.
Update the GOOGLE_CUSTOMER_ACTIONS Metric
- Find and replace instances of
GOOGLE_CUSTOMER_ACTIONS
with the new API name:LISTINGS_ACTIONS
. - Review the dimensions applied to the each metric, and ensure that it is one of the following supported dimensions:
ACTION
IS_CLICK
DAYS
WEEKS
MONTHS
QUARTERS
ENTITY_IDS
ENTITY_TYPES
ENTITY_LABELS
FOLDER_NAMES
The compatible dimensions for the legacy metrics are different from the compatible dimensions for the new metrics. Visit our Location Listings Metrics documentation for a full list of the supported dimensions per metric.
Update the GOOGLE_MAP_VIEWS Metric
- Find and replace instances of
GOOGLE_MAP_VIEWS
with the new API name:LISTINGS_IMPRESSIONS
. - Review the dimensions applied to the each metric, and ensure that it is one of the following supported dimensions:
APP
DEVICE
DAYS
WEEKS
MONTHS
QUARTERS
ENTITY_IDS
ENTITY_TYPES
ENTITY_LABELS
FOLDER_NAMES
- To ensure accurate replacement of this data, apply the
APP
dimension and filter byMAPS
.
The compatible dimensions for the legacy metrics are different from the compatible dimensions for the new metrics. Visit our Location Listings Metrics documentation for a full list of the supported dimensions per metric.
Update the GOOGLE_SEARCH_VIEWS Metric
- Find and replace instances of
GOOGLE_SEARCH_VIEWS
with the new API name:LISTINGS_IMPRESSIONS
. - Review the dimensions applied to the each metric, and ensure that it is one of the following supported dimensions:
APP
DEVICE
DAYS
WEEKS
MONTHS
QUARTERS
ENTITY_IDS
ENTITY_TYPES
ENTITY_LABELS
FOLDER_NAMES
- To ensure accurate replacement of this data, apply the
APP
dimension and filter bySEARCH
.
The compatible dimensions for the legacy metrics are different from the compatible dimensions for the new metrics. Visit our Location Listings Metrics documentation for a full list of the supported dimensions per metric.