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.
Here’s a list of metrics that are available in Piwik PRO when you use Google Search Console integration.
Name Average position (search engine) Scopes Google Search Console Availability Query API Type float
Name Clicks (search engine) Scopes Google Search Console Availability Query API Type int
Name CTR (search engine) Scopes Google Search Console Availability Query API Type float
Name Impressions (search engine) Scopes Google Search Console Availability Query API Type int
Here’s a list of dimensions that are available in Piwik PRO when you use Google Search Console integration.
Name Device type Scopes event, product, session Availability Real-time, Query API, Raw data API Type [int, str] Database type uint8 Nullable true Notes device_type.json
Name Continent Scopes event, product, session Availability Real-time, Query API, Raw data API Type [str, str] Database type string(2) Nullable true Notes location_continent_iso_code.json
Name Country 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”)
Name Medium Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Channel Scopes event, product, session Availability Real-time, Query API, Raw data API Type [int, str] Database type uint8 Nullable false Notes referrer_type.json
Name Referrer URL Scopes event, product, session Availability Real-time, Query API, Raw data API Type str Database type string Nullable false
Name Search engine keyword Scopes Google Search Console Availability Query API Type str Database type string Nullable false
Name Session entry URL Scopes event, product, session Availability Query API, Raw data API Type str Database type string Nullable false
Name Source Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Source / medium Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Date 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
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.
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.
Name Device type Scopes event, product, session Availability Real-time, Query API, Raw data API Type [int, str] Database type uint8 Nullable true Notes device_type.json
Name Continent Scopes event, product, session Availability Real-time, Query API, Raw data API Type [str, str] Database type string(2) Nullable true Notes location_continent_iso_code.json
Name Country 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”)
Name Medium Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Channel Scopes event, product, session Availability Real-time, Query API, Raw data API Type [int, str] Database type uint8 Nullable false Notes referrer_type.json
Name Referrer URL Scopes event, product, session Availability Real-time, Query API, Raw data API Type str Database type string Nullable false
Name Session entry URL Scopes event, product, session Availability Query API, Raw data API Type str Database type string Nullable false
Name Source Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Source / medium Scopes event, product, session Availability Real-time, Query API, Raw data API Type str_nocase Database type string Nullable false
Name Date 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
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.
