Getting started

​
connections

The Search Console operations in orc connections list properties accessible to your connected Google account, select a property, and retrieve search performance, URL indexing status, and submitted sitemaps. Filter performance data by query, page, country, device, and other supported dimensions.

Property selection is saved on the Orchestor connection. These operations do not modify Google settings or sitemaps. Start by finding the connection ID and selecting the property to query.

​
Usage

terminal
orc connections list --workspace YOUR_WORKSPACE_ID --provider google-search-console --format json

Example

​
Subcommands

​
search-console-sites-list

List accessible properties

terminal
orc connections search-console-sites-list <id> [options]

​
search-console-site-select

Select a property for the connection

terminal
orc connections search-console-site-select <id> [options]

​
Unique options

​
--site-url

(required) Body field: site_url; max 2048 chars

Type: string. Optional.

terminal
orc connections search-console-site-select <id> --site-url <value>

​
search-console-analytics-query

Read search performance

terminal
orc connections search-console-analytics-query <id> [options]

​
Unique options

​
--aggregation-type

Body field: aggregation_type; enum: auto|byPage|byProperty|byNewsShowcasePanel

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --aggregation-type <value>
​
--data-state

Body field: data_state; enum: final|all|hourly_all

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --data-state <value>
​
--dimension-filter-groups

Body field: dimension_filter_groups; JSON array of objects (use --stdin for large resources)

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --dimension-filter-groups <value>
​
--dimensions

Body field: dimensions; csv of: date|query|page|country|device|searchAppearance|hour

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --dimensions <value>
​
--end-date

(required) Inclusive date in America/Los_Angeles (Pacific Time).

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --end-date <value>
​
--row-limit

Body field: row_limit

Type: number. Optional.

terminal
orc connections search-console-analytics-query <id> --row-limit <value>
​
--start-date

(required) Inclusive date in America/Los_Angeles (Pacific Time).

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --start-date <value>
​
--start-row

Body field: start_row

Type: number. Optional.

terminal
orc connections search-console-analytics-query <id> --start-row <value>
​
--type

Body field: type; enum: web|image|video|news|discover|googleNews

Type: string. Optional.

terminal
orc connections search-console-analytics-query <id> --type <value>

​
search-console-url-inspect

Read a URL's indexed state

terminal
orc connections search-console-url-inspect <id> [options]

​
Unique options

​
--inspection-url

(required) Body field: inspection_url; max 2048 chars

Type: string. Optional.

terminal
orc connections search-console-url-inspect <id> --inspection-url <value>
​
--language-code

BCP-47 language code, for example en-US.; max 35 chars

Type: string. Optional.

terminal
orc connections search-console-url-inspect <id> --language-code <value>

​
search-console-sitemaps-list

Read submitted sitemaps

terminal
orc connections search-console-sitemaps-list <id> [options]

​
Examples

​
Example

terminal
orc connections search-console-sites-list YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --format json
orc connections search-console-site-select YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --site-url 'sc-domain:example.com' --format json

Example

​
Example

terminal
orc connections search-console-analytics-query YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --start-date 2026-09-01 --end-date 2026-09-30 --dimensions query,page --row-limit 1000 --format json

Example

​
Example

Save the following JSON as analytics.json.

terminal
orc connections search-console-analytics-query YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --stdin --format json < analytics.json

Example

analytics.json
{
  "start_date": "2026-09-01",
  "end_date": "2026-09-30",
  "dimensions": [
    "page"
  ],
  "dimension_filter_groups": [
    {
      "filters": [
        {
          "dimension": "page",
          "operator": "contains",
          "expression": "/blog/"
        }
      ]
    }
  ]
}

​
Example

terminal
orc connections search-console-url-inspect YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --inspection-url 'https://example.com/page' --language-code en-US --format json

Example

​
Example

terminal
orc connections search-console-sitemaps-list YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --format json

Example

​
Permissions

Connect a Google account that can read the property and authorize the webmasters.readonly scope. Orchestor requires authentication and an accessible workspace.

​
Global Options

The following global options can be used with orc connections:

For details and examples, see global options.