end_dateRequiredstringThe end date of the date range for the query, in YYYY-MM-DD format. Example: "2023-12-31"
site_urlRequiredstringThe site's URL, including protocol (e.g., https://www.example.com/) or a domain property (e.g., sc-domain:example.com). URL-prefix properties specify exact protocol and path, while domain properties aggregate data across all subdomains and protocols. Examples: "https://www.examp…
row_limitintegerThe maximum number of rows to return. Must be between 1 and 25,000. Note: The API returns top results sorted by clicks (or date when grouping by date). Must be between 1 and 5000. Use start_row to paginate; stop when response rows < row_limit.
start_rowintegerThe first row to return from the result set. Used for pagination.
data_statestringThe data state to return. Examples: "final" "all" "hourly_all"
dimensionsarrayThe dimensions to group the data by. Results are sorted by clicks descending, except when grouping by date (sorted by date ascending). Examples: ["query","page"] ["country","device"] ["date"]
start_dateRequiredstringThe start date of the date range for the query, in YYYY-MM-DD format. Data lags 2–3 days (UTC); most recent 1–2 days may be incomplete. Data retention is ~16 months; older ranges return zero rows. Example: "2023-01-01"
search_typestringThe search type to filter results by. Examples: "web" "image" "video"
aggregation_typestringHow data is aggregated. Examples: "auto" "byProperty" "byPage"
dimension_filter_groupsarrayOptional filters to apply to dimensions. Each filter group contains an array of filters with structure: [{'filters': [{'dimension': 'country', 'operator': 'equals', 'expression': 'USA'}]}]. Operators: equals, notEquals, contains, notContains, includingRegex, excludingRegex. Inva…
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action