Google Search Console API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "google_search_console",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "reports": [
      {
        "aggregation": "BY_PROPERTY | BY_PAGE",
        "dimensions": [
          "DATE | COUNTRY | HOUR | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE"
        ],
        "filters": [
          {
            "dimension": "COUNTRY | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE",
            "expression": "string",
            "filter_type": "EXCLUDE | INCLUDE",
            "match_type": "EQUALS | CONTAINS"
          }
        ],
        "report_type": "DISCOVER | GOOGLE_NEWS | SEARCH_RESULTS",
        "search_types": [
          "IMAGE | WEB | VIDEO | NEWS | DISCOVER | GOOGLE_NEWS"
        ],
        "table": "search_report"
      }
    ],
    "site_urls": [
      "string"
    ],
    "sync_mode": "AllSites | SpecificSites",
    "timeframe_months": "SIX | ALL_TIME | TWELVE | THREE",
    "schema": "schema_name"
  },
  "auth": {
    "client_access": {
      "client_id": "my_client_id",
      "client_secret": "my_client_secret"
    },
    "refresh_token": "string"
  }
}

Config parameters

Name	Description
`reports`	The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
`reports[0].aggregation`	(Optional) Aggregation type. Supported only for the `SEARCH_RESULTS` report type
`reports[0].dimensions`	The report dimensions included to sync.
`reports[0].filters`	The list of filters to be applied to the report.
`reports[0].filters[0].dimension`
`reports[0].filters[0].expression`
`reports[0].filters[0].filter_type`
`reports[0].filters[0].match_type`
`reports[0].report_type`	The type of report
`reports[0].search_types`	Search types included to sync. Supported only for the `SEARCH_RESULTS` report type
`reports[0].table`	The name of a table within the schema to which connector syncs the data of a given report.
`site_urls`	Specific Site URLs to sync. Must be populated if `sync_mode` is set to `SpecificSites`.
`sync_mode`	Whether to sync all sites or specific sites.
`timeframe_months`	Number of months' worth of reporting data you'd like to include in your initial sync. A change of this value will trigger a re-sync for enabled reports during the next connector sync.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_access and refresh_token parameters in the auth section.

POST https://api.fivetran.com/v1/connections

{
  "service": "google_search_console",
  "group_id": "group_id",
  "auth": {
    "client_access": {
      "client_id": "my_client_id",
      "client_secret": "my_client_secret"
    },
    "refresh_token": "string"
  }
}

Auth Parameters

Name	Description
`client_access`
`client_access.client_id`	`Client ID` of your Google Search Console client application.
`client_access.client_secret`	`Client Secret` of your Google Search Console client application.
`refresh_token`

By using the Connect Card or the Fivetran dashboard.