Data Capture Parameters - PromInc/organic-search-analytics GitHub Wiki

For the average user that utilizes the GUI only, these instructions will not be important. However if you wish to utilize this tool for programmatic means, automate it via a CRON job, etc. the following information describes what parameters are necessary.

To initiate the data capture from Google Search Console or Bing Webmaster Tools, a request to data-capture-run.php is required with the appropriate GET parameters set.

This table describes what parameters are available to be set:

Parameter	Req.	Format	Search Engine	Notes
type	Yes	string	All	Google: googleSearchAnalytics Bing: bingSearchKeywords
domain	Yes	string	All	Must match exactly to how it appears in Google Search Console and/or Bing Webmaster Tools.
date	Yes	yyyy-mm-dd	All	Google: The date specified is the date for which data will be captured. Bing: The date is irrelevant as Bing pulls back all available data for multiple dates regardless of the date specified. A properly formatted date is still required however.
mode	No	string	All	Specifies the action to take upon retrieving data from the API. Default: import Options: - import: Import the retrieved data to the database - return: Return all data directly from the Search Engine API response. Data will not be imported to the database.
row_limit	No	integer	Google	Default: 5000
dimensions	No	string	Google	Comma (,) separate multiple values.
filters	No	string	Google	Pipe (|) separate multiple filters with comma (,) separated settings in the order of dimension (required), expression (required), operator (optional, defaults to contains).
aggregation_type	No	string	Google	Not set by default.
search_type	No	string	Google	Comma (,) separate multiple values. Options: - web - image - video Added in version 2.3.2
For more information regarding the various parameters allowed by the Google Search Analytics API, read the Google Help documentation.