Custom Report

Using the Custom Report pipeline users will be able to query their search traffic data for search type, impressions, clicks, CTR, etc. The pipeline returns zero or more rows grouped by the row keys (dimensions) - as defined by user. A user must define a date range of one or more days.

When date is one of the dimensions, any days without data are omitted from the result list. To learn which days have data, issue a query without filters grouped by date, for the date range of interest. The results are sorted by click count descending. If two rows have the same click count, they are sorted in an arbitrary way.

Configuring the Credentials

Select the account credentials which has access to relevant Google Search Console data from the dropdown menu & Click Next

Credentials not listed in dropdown ?: Click on + Add New for adding new credentials

Data Pipelines Details

Data Pipeline: Select Custom Report from the dropdown

Setting Parameters

Parameter Description Values

Parameter	Description	Values
URL	*Required* Enter the URL of the property as defined in the Search Console. Example: http://www.example.com/	String value
Dimensions	*Required* Select the dimensions you would like to fetch from the Google Search Console. Results are grouped in the order that you supply these dimensions. The grouping dimension values are combined to create a unique key for each result row.	`date`,`page`,`query`,`country`,`device`,`search appearance`
Search Type	*Required* Select the data search type you would like to fetch from the Google Search Console.	`web`.`image`,`video`
Insert Mode	*Required* This refers to the manner in which data will get updated in the data warehouse, with 'Delete' selected, the data will be upserted (only new records or records with changes) and with 'Append' selected, all data fetched will be inserted. Selecting 'Replace' will ensure the table is dropped and recreated with fresh data on each run. Recommended to use "Upsert" option unless there is a specific requirement.	`Upsert`, `Append`, `Replace` *Default Value:* Upsert
Number of Days	*Required* Number of days for which you wish to get the data in each run.	Integer value (Recommended value 2)

URL

Required

Enter the URL of the property as defined in the Search Console. Example: http://www.example.com/

String value

Dimensions

Required

Select the dimensions you would like to fetch from the Google Search Console. Results are grouped in the order that you supply these dimensions. The grouping dimension values are combined to create a unique key for each result row.

date,page,query,country,device,search appearance

Search Type

Required

Select the data search type you would like to fetch from the Google Search Console.

web.image,video

Insert Mode

Required

This refers to the manner in which data will get updated in the data warehouse, with 'Delete' selected, the data will be upserted (only new records or records with changes) and with 'Append' selected, all data fetched will be inserted. Selecting 'Replace' will ensure the table is dropped and recreated with fresh data on each run. Recommended to use "Upsert" option unless there is a specific requirement.

Upsert, Append, Replace

Default Value: Upsert

Number of Days

Required

Number of days for which you wish to get the data in each run.

Integer value (Recommended value 2)

Datapipeline Scheduling

Scheduling specifies the frequency with which data will get updated in the data warehouse. You can choose between Manual Run, Normal Scheduling or Advance Scheduling.

Manual Run: If scheduling is not required, you can use the toggle to run the pipeline manually.
Normal Scheduling: Use the dropdown to select an interval-based hourly, monthly, weekly, or daily frequency.
Advance Scheduling: Set schedules fine-grained at the level of Months, Days, Hours, and Minutes.

Detailed explanation on scheduling of pipelines can be found here

Dataset & Name

Dataset Name: Key in the Dataset Name(also serves as the table name in your data warehouse).Keep in mind, that the name should be unique across the account and the data source. Special characters (except underscore _) and blank spaces are not allowed. It is best to follow a consistent naming scheme for future search to locate the tables.
Dataset Description: Enter a short description (optional) describing the dataset being fetched by this particular pipeline.
Notifications: Choose the events for which you’d like to be notified: whether "ERROR ONLY" or "ERROR AND SUCCESS".

Once you have finished click on Finish to save it. Read more about naming and saving your pipelines including the option to save them as templates here

Still have Questions?

We’ll be happy to help you with any questions you might have! Send us an email at info@datachannel.co.

Subscribe to our Newsletter for latest updates at DataChannel.