API Reference › integrations › google_search_console

google_search_console

integrations Write

Read Google Search Console organic-search data for the user's verified sites, and submit URLs to the Google Indexing API

Endpoint

POST https://api.adspirer.ai/api/v1/tools/google_search_console/execute

Headers

Description

Read Google Search Console organic-search data for the user's verified sites, and submit URLs to the Google Indexing API. Use this when the user asks about: - Organic search performance — clicks, impressions, CTR, average position - Which search queries bring traffic, and which pages rank for them - Breakdowns by query, page, country, device, or date - Comparing PAID search (our Google Ads tools) against ORGANIC search - 'What keywords am I ranking for?', 'why did my organic traffic drop?', 'which pages lost impressions?' - Asking Google to re-crawl a page after publishing or updating it Two actions are available: `google_search_console-retrieve-site-performance-data` (read; needs `siteUrl`, `startDate`, `endDate`, optional `dimensions` like ['query','page']) and `google_search_console-submit-url-for-indexing` (WRITE — notifies Google a URL was updated or deleted; confirm with the user first). The user must have connected Google Search Console in the Adspirer Connections tab. If not connected, this tool returns a connect link the user can click.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
actionstring required'list_tools': discover available actions for this app. 'execute': run a specific action by name. one of: list_tools, execute
tool_namestring optionalName of the Pipedream action to execute (required when action='execute'). Get exact names + parameters from action='list_tools' first.
argumentsobject optionalArguments object to pass to the action (required when action='execute').

Example request

{
  "arguments": {
    "action": "list_tools"
  }
}

Example responses

200 — Success

{
  "success": true,
  "data": {
    "text": "(tool-specific textual output for google_search_console)",
    "quota": {
      "used": 42,
      "limit": 150,
      "tier": "plus",
      "period_end": "2026-05-01"
    }
  },
  "tool": "google_search_console"
}

400 — Tool-level error (bad arguments / multi-account selection)

{
  "success": false,
  "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n  - Acme Holdings (ad_account_id=\"act_123456789\")\n  - Acme EU (ad_account_id=\"act_987654321\")",
  "is_error": true,
  "tool": "google_search_console"
}

402 — Quota exhausted

{
  "success": false,
  "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
  "is_error": true,
  "tool": "google_search_console",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live

Interactive: Swagger UI

Machine-readable: OpenAPI 3.1 spec · llms-full.txt

More tools: integrations · All tools

Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai