{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper - Multi-Country Reports & Insights", "description": "Google Trends scraper for many keywords and countries: interest over time, by region, rising searches, insights, ONE scale for 50+ keywords with ranking, and weekly what's-new monitoring. Pay only for reports with data.", "version": "0.3", "x-build-id": "NXViKdjo7GDNwille" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/skydata~google-trends-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-skydata-google-trends-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/skydata~google-trends-scraper/runs": { "post": { "operationId": "runs-sync-skydata-google-trends-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/skydata~google-trends-scraper/run-sync": { "post": { "operationId": "run-sync-skydata-google-trends-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Search terms to look up. Each keyword gets its own report (or turn on 'Compare keywords' to put up to 5 on the same scale).", "items": { "type": "string" } }, "locations": { "title": "Locations (country codes)", "type": "array", "description": "Two-letter country codes like US, GB, IN, BR, or region codes like US-CA. Leave one empty line for Worldwide. Every keyword is checked in every location.", "default": [ "" ], "items": { "type": "string" } }, "timeframe": { "title": "Time range", "enum": [ "now 1-H", "now 4-H", "now 1-d", "now 7-d", "today 1-m", "today 3-m", "today 12-m", "today 5-y", "all" ], "type": "string", "description": "Period to analyse. Custom ranges use 'YYYY-MM-DD YYYY-MM-DD'.", "default": "today 12-m" }, "sections": { "title": "What to include", "type": "array", "description": "Report sections. Related topics are currently often empty on Google's side; they are never charged separately.", "items": { "type": "string", "enum": [ "interestOverTime", "interestByRegion", "relatedQueries", "relatedTopics" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries (top + rising)", "Related topics" ] }, "default": [ "interestOverTime", "interestByRegion", "relatedQueries" ] }, "comparison": { "title": "Comparison mode", "enum": [ "none", "groups", "one_scale" ], "type": "string", "description": "Separate: each keyword gets its own report. Groups of 5: up to 5 keywords on one scale per report (like Google's compare view). ONE scale for all: any number of keywords on one common 0-100 scale plus a ranking (chained through an anchor keyword; uses one Google request per 4 extra keywords).", "default": "none" }, "anchorKeyword": { "title": "Anchor keyword (for ONE scale mode)", "type": "string", "description": "Optional. The keyword used to connect the groups. Best: a keyword with medium, steady interest. Default: the first keyword." }, "searchType": { "title": "Search type", "enum": [ "web", "images", "news", "youtube", "froogle" ], "type": "string", "description": "Which Google search to analyse: web (default), images, news, YouTube or Google Shopping.", "default": "web" }, "category": { "title": "Category ID", "type": "integer", "description": "Google Trends category number (0 = all categories).", "default": 0 }, "regionResolution": { "title": "Region detail", "enum": [ "", "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Leave empty for Google's default (countries for Worldwide, regions inside a country, metro areas inside US states). If Google has no data at the chosen detail (often the case for cities), the default level is returned with a note.", "default": "" }, "includeLowVolumeRegions": { "title": "Include low-volume regions", "type": "boolean", "description": "Also show regions with very little search volume (Google hides them by default).", "default": false }, "monitorChanges": { "title": "Monitor changes (what's new since last run)", "type": "boolean", "description": "Remember results between runs and add a 'changes' section: new Breakout searches, new rising searches, % change since last run and top-region changes. Use with Apify Schedules (e.g. weekly). A summary is saved as CHANGES_SUMMARY.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Name for this monitor, so different keyword lists keep separate history (e.g. 'client-a-weekly').", "default": "default" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google blocks most data-centre IPs. Residential proxy is recommended and is the default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "pacingMs": { "title": "Pause between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Average pause between calls to Google. Higher is slower but safer.", "default": 600 }, "maxAttempts": { "title": "Attempts per request", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many times to retry a request when Google slows the robot down. Failed reports are never charged.", "default": 6 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }