Google Search Console API Configuration
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
},
"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"
},
"config": {
"sync_mode": "AllSites | SpecificSites",
"reports": [
{
"aggregation": "BY_PROPERTY | BY_PAGE",
"filters": [
{
"expression": "string",
"filter_type": "EXCLUDE | INCLUDE",
"match_type": "EQUALS | CONTAINS",
"dimension": "COUNTRY | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE"
}
],
"report_type": "DISCOVER | GOOGLE_NEWS | SEARCH_RESULTS",
"search_types": [
"IMAGE | WEB | VIDEO | NEWS | DISCOVER | GOOGLE_NEWS"
],
"table": "search_report",
"dimensions": [
"DATE | COUNTRY | QUERY | DEVICE | PAGE | SEARCH_APPEARANCE"
]
}
],
"timeframe_months": "SIX | ALL_TIME | TWELVE | THREE",
"site_urls": [
"string"
],
"schema": "schema_name"
},
"auth": {
"refresh_token": "string",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}Config parameters
| Name | Description |
|---|---|
sync_mode | Whether to sync all sites or specific sites. |
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].filters | The list of filters to be applied to the report. |
reports[0].filters[0].expression | |
reports[0].filters[0].filter_type | |
reports[0].filters[0].match_type | |
reports[0].filters[0].dimension | |
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. |
reports[0].dimensions | The report dimensions included to sync. |
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. |
site_urls | Specific Site URLs to sync. Must be populated if sync_mode is set to SpecificSites. |
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_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "google_search_console", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "string" } }Auth Parameters
Name Description refresh_tokenclient_accessclient_access.client_secretClient Secretof your Google Search Console client application.client_access.client_idClient IDof your Google Search Console client application. By using the Connect Card or the Fivetran dashboard.