gog searchconsole searchanalytics query
Generated from
gog schema --json. Do not edit this page by hand; runmake docs-commands.
Run a Search Analytics query
#Usage
gog searchconsole (gsc,search-console,webmasters) searchanalytics (analytics) query (run) <siteUrl> [flags]#Parent
#Flags
| Flag | Type | Default | Help |
|---|---|---|---|
--access-token | string | Use provided access token directly (bypasses stored refresh tokens; token expires in ~1h) | |
-a--account--acct | string | Account email for API commands (gmail/calendar/chat/classroom/drive/drivelabels/docs/slides/contacts/tasks/people/sheets/forms/sites/appscript/analytics/searchconsole/ads/photos) | |
--aggregation | string | Aggregation type (AUTO,BYPROPERTY,BYPAGE,BYNEWSSHOWCASE_PANEL) | |
--client | string | OAuth client name (selects stored credentials + token bucket) | |
--color | string | auto | Color output: auto|always|never |
--data-state | string | Data state (FINAL,ALL,HOURLY_ALL) | |
--dimensions | string | QUERY | Comma-separated dimensions (DATE,QUERY,PAGE,COUNTRY,DEVICE,SEARCH_APPEARANCE,HOUR) |
--disable-commands | string | Comma-separated list of disabled commands; dot paths allowed | |
-n--dry-run--dryrun--noop--preview | bool | Do not make changes; print intended actions and exit successfully | |
--enable-commands | string | Comma-separated list of enabled commands; dot paths allowed (restricts CLI) | |
--fail-empty--non-empty--require-results | bool | Exit with code 3 if no rows | |
--filter | []string | Dimension filter, repeatable: dimension:operator:expression | |
-y--force--assume-yes--yes | bool | Skip confirmations for destructive commands | |
--from--start | string | Start date (YYYY-MM-DD) | |
--gmail-no-send | bool | false | Block Gmail send operations (agent safety) |
-h--help | kong.helpFlag | Show context-sensitive help. | |
--home | string | Override gogcli config/data/state/cache root (equivalent to GOG_HOME) | |
-j--json--machine | bool | false | Output JSON to stdout (best for scripting) |
--max--limit | int64 | 1000 | Max rows to return (1-25000) |
--no-input--non-interactive--noninteractive | bool | Never prompt; fail instead (useful for CI) | |
--offset--start-row | int64 | 0 | Row offset for pagination |
-p--plain--tsv | bool | false | Output stable, parseable text to stdout (TSV; no colors) |
--request | string | SearchAnalyticsQueryRequest JSON spec. Accepts @file, a plain file path, -, or inline JSON. | |
--results-only | bool | In JSON mode, emit only the primary result (drops envelope fields like nextPageToken) | |
--select--pick--project | string | In JSON mode, select comma-separated fields (best-effort; supports dot paths). Desire path: use --fields for most commands. | |
--to--end | string | End date (YYYY-MM-DD) | |
--type | string | WEB | Search type (WEB,IMAGE,VIDEO,NEWS,DISCOVER,GOOGLE_NEWS) |
-v--verbose | bool | Enable verbose logging | |
--version | kong.VersionFlag | Print version and exit | |
--wrap-untrusted | bool | false | In JSON/raw output, wrap fetched text fields in external untrusted-content markers |