Google Search Console

Note:

• 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

NameAverage position (search engine)
DescriptionThe 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).
ScopesGoogle Search Console
AvailabilityQuery API
Typefloat

search_engine_clicks

NameClicks (search engine)
DescriptionThe number of clicks on your website URLs from Google Search results. It doesn’t include clicks on paid Google Ads search results.
ScopesGoogle Search Console
AvailabilityQuery API
Typeint

search_engine_ctr

NameCTR (search engine)
DescriptionThe click-through rate. CTR = (Clicks / Impressions) * 100 .
ScopesGoogle Search Console
AvailabilityQuery API
Typefloat

search_engine_impressions

NameImpressions (search engine)
DescriptionThe 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.
ScopesGoogle Search Console
AvailabilityQuery API
Typeint

Dimensions

Here’s a list of dimensions that are available in Piwik PRO when you use Google Search Console integration.

device_type

NameDevice type
DescriptionThe type of the visitor’s device.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesdevice_type.json

location_continent_iso_code

NameContinent
DescriptionThe continent from which a visitor entered your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(2)
Nullabletrue
Noteslocation_continent_iso_code.json

location_country_name

NameCountry
DescriptionThe country from which a visitor entered your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring
Nullabletrue
NotesISO 3166-2 codes (e.g. “PL”)

medium

NameMedium
DescriptionThe 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.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

referrer_type

NameChannel
DescriptionThe channel of the incoming traffic. The channels are: direct entry, search engine, website, and campaign.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notesreferrer_type.json

referrer_url

NameReferrer URL
DescriptionThe URL of the page that referred a visitor to your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

search_engine_keyword

NameSearch engine keyword
DescriptionQueries that generated impressions of your website’s URLs in Google organic search results.
ScopesGoogle Search Console
AvailabilityQuery API
Typestr
Database typestring
Nullablefalse

session_entry_url

NameSession entry URL
DescriptionThe URL of the first visited page during the session.
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

source

NameSource
DescriptionThe origin of the incoming traffic such as direct, a search engine (for example, google) or a domain (example.com).
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

source_medium

NameSource / medium
DescriptionA dimension that combines two dimensions: source and medium. Source is the origin of the incoming traffic. Medium is the category of the source.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

timestamp

NameDate
DescriptionDay and time of the event in the site’s time zone.
Scopesevent, product, session
AvailabilityReal-time, Query API
Typedate
Database typenot applicable
Nullablefalse
Notesserver time in the website’s time zone

website_name

NameSite or app name
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typenot applicable
Nullablefalse
Noteswebsite 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.

Here’s a list of the dimensions that you can use.

device_type

NameDevice type
DescriptionThe type of the visitor’s device.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullabletrue
Notesdevice_type.json

location_continent_iso_code

NameContinent
DescriptionThe continent from which a visitor entered your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring(2)
Nullabletrue
Noteslocation_continent_iso_code.json

location_country_name

NameCountry
DescriptionThe country from which a visitor entered your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typestring
Nullabletrue
NotesISO 3166-2 codes (e.g. “PL”)

medium

NameMedium
DescriptionThe 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.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

referrer_type

NameChannel
DescriptionThe channel of the incoming traffic. The channels are: direct entry, search engine, website, and campaign.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[int, str]
Database typeuint8
Nullablefalse
Notesreferrer_type.json

referrer_url

NameReferrer URL
DescriptionThe URL of the page that referred a visitor to your site or app.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr
Database typestring
Nullablefalse

session_entry_url

NameSession entry URL
DescriptionThe URL of the first visited page during the session.
Scopesevent, product, session
AvailabilityQuery API, Raw data API
Typestr
Database typestring
Nullablefalse

source

NameSource
DescriptionThe origin of the incoming traffic such as direct, a search engine (for example, google) or a domain (example.com).
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

source_medium

NameSource / medium
DescriptionA dimension that combines two dimensions: source and medium. Source is the origin of the incoming traffic. Medium is the category of the source.
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Typestr_nocase
Database typestring
Nullablefalse

timestamp

NameDate
DescriptionDay and time of the event in the site’s time zone.
Scopesevent, product, session
AvailabilityReal-time, Query API
Typedate
Database typenot applicable
Nullablefalse
Notesserver time in the website’s time zone

website_name

NameSite or app name
Scopesevent, product, session
AvailabilityReal-time, Query API, Raw data API
Type[str, str]
Database typenot applicable
Nullablefalse
Noteswebsite 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.