• Google Search Console data isn't available in the real-time API.
• For the data to be available, set up the Google Search Console integration in Menu > Analytics > Settings > Integrations.
Metrics
Here’s a list of metrics that are available in Piwik PRO when you use Google Search Console integration.
search_engine_average_position
Name
Average position (search engine)
Description
The average ranking of your website’s URL for the one or more keywords. For example, if your site’s URL appeared at position 3 for one keyword and position 7 for another keyword, the average position would be 5 ((3+7)/2).
Scopes
Google Search Console
Availability
Query API
Type
float
search_engine_clicks
Name
Clicks (search engine)
Description
The number of clicks on your website URLs from Google Search results. It doesn’t include clicks on paid Google Ads search results.
The number of times any URL from your site appeared in Google search results and was seen by a visitor. It doesn’t include paid Google Ads search impressions.
Scopes
Google Search Console
Availability
Query API
Type
int
Dimensions
Here’s a list of dimensions that are available in Piwik PRO when you use Google Search Console integration.
The country from which a visitor entered your site or app.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
[str, str]
Database type
string
Nullable
true
Notes
ISO 3166-2 codes (e.g. “PL”)
medium
Name
Medium
Description
The category of the source such as organic (unpaid search in the search engine), cpc (paid search in the search engine), referral (web referral), email (email campaign), and the like.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
referrer_type
Name
Channel
Description
The channel of the incoming traffic. The channels are: direct entry, search engine, website, and campaign.
The URL of the page that referred a visitor to your site or app.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str
Database type
string
Nullable
false
search_engine_keyword
Name
Search engine keyword
Description
Queries that generated impressions of your website’s URLs in Google organic search results.
Scopes
Google Search Console
Availability
Query API
Type
str
Database type
string
Nullable
false
session_entry_url
Name
Session entry URL
Description
The URL of the first visited page during the session.
Scopes
event, product, session
Availability
Query API, Raw data API
Type
str
Database type
string
Nullable
false
source
Name
Source
Description
The origin of the incoming traffic such as direct, a search engine (for example, google) or a domain (example.com).
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
source_medium
Name
Source / medium
Description
A dimension that combines two dimensions: source and medium. Source is the origin of the incoming traffic. Medium is the category of the source.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
timestamp
Name
Date
Description
Day and time of the event in the site’s time zone.
Scopes
event, product, session
Availability
Real-time, Query API
Type
date
Database type
not applicable
Nullable
false
Notes
server time in the website’s time zone
website_name
Name
Site or app name
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
[str, str]
Database type
not applicable
Nullable
false
Notes
website UUID
Note:
The Database type column displays the source type associated with each dimension. For the enum dimensions, it displays the ID type. For the not applicable source type, this column represents a dynamic dimension.
Mixed queries
You can request both internal analytics and Google Search Console metrics in a single query, for example Sessions and Clicks (search engine). However, only the common dimensions listed below can be used in these queries.
The country from which a visitor entered your site or app.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
[str, str]
Database type
string
Nullable
true
Notes
ISO 3166-2 codes (e.g. “PL”)
medium
Name
Medium
Description
The category of the source such as organic (unpaid search in the search engine), cpc (paid search in the search engine), referral (web referral), email (email campaign), and the like.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
referrer_type
Name
Channel
Description
The channel of the incoming traffic. The channels are: direct entry, search engine, website, and campaign.
The URL of the page that referred a visitor to your site or app.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str
Database type
string
Nullable
false
session_entry_url
Name
Session entry URL
Description
The URL of the first visited page during the session.
Scopes
event, product, session
Availability
Query API, Raw data API
Type
str
Database type
string
Nullable
false
source
Name
Source
Description
The origin of the incoming traffic such as direct, a search engine (for example, google) or a domain (example.com).
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
source_medium
Name
Source / medium
Description
A dimension that combines two dimensions: source and medium. Source is the origin of the incoming traffic. Medium is the category of the source.
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
str_nocase
Database type
string
Nullable
false
timestamp
Name
Date
Description
Day and time of the event in the site’s time zone.
Scopes
event, product, session
Availability
Real-time, Query API
Type
date
Database type
not applicable
Nullable
false
Notes
server time in the website’s time zone
website_name
Name
Site or app name
Scopes
event, product, session
Availability
Real-time, Query API, Raw data API
Type
[str, str]
Database type
not applicable
Nullable
false
Notes
website UUID
Note:
• The Database type column displays the source type associated with each dimension. For the enum dimensions, it displays the ID type. For the not applicable source type, this column represents a dynamic dimension.
• Using dimensions not listed in the table above as query columns or filters will result in a Bad Request response.