{ "openapi": "3.0.1", "info": { "title": "Google Trends Scraper: Bulk, Comparable Scale, Related Queries", "version": "0.1", "x-build-id": "pjLntC3Vf8igrhajX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/variegated_binturong~google-trends-bulk-comparable/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-variegated_binturong-google-trends-bulk-comparable", "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/variegated_binturong~google-trends-bulk-comparable/runs": { "post": { "operationId": "runs-sync-variegated_binturong-google-trends-bulk-comparable", "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/variegated_binturong~google-trends-bulk-comparable/run-sync": { "post": { "operationId": "run-sync-variegated_binturong-google-trends-bulk-comparable", "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 or topics to analyse. One per line. Up to 500.", "items": { "type": "string" } }, "geo": { "title": "Country / region code", "type": "string", "description": "ISO code such as US, GB, DE, IT or US-CA. Leave empty for worldwide.", "default": "US" }, "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. Use the custom range below for exact dates.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom date range (optional)", "type": "string", "description": "Format: YYYY-MM-DD YYYY-MM-DD, for example 2025-01-01 2025-06-30. Overrides the time range above." }, "property": { "title": "Search type", "enum": [ "web", "youtube", "news", "images", "shopping" ], "type": "string", "description": "Which Google property the searches come from.", "default": "web" }, "category": { "title": "Category ID", "minimum": 0, "type": "integer", "description": "Google Trends category number. 0 means all categories (e.g. 71 = Food & Drink, 5 = Computers & Electronics).", "default": 0 }, "includeInterestOverTime": { "title": "Include full time series", "type": "boolean", "description": "Adds the weekly/daily values to every result. Turn off to get only the summary and trend flags.", "default": true }, "comparableScale": { "title": "Comparable scale across all keywords", "type": "boolean", "description": "Google normalises every request to 0-100, so keywords checked separately cannot be compared. Turn this on to get values on ONE common scale for any number of keywords (uses an anchor keyword to join batches).", "default": false }, "anchorKeyword": { "title": "Anchor keyword (optional)", "type": "string", "description": "Used only with comparable scale. Pick a keyword with steady, mid-level interest. Default: the first keyword." }, "includeRelatedQueries": { "title": "Include related queries", "type": "boolean", "description": "Top and rising related searches, with breakout flags. Charged as an extra event when data exists.", "default": false }, "includeRelatedTopics": { "title": "Include related topics", "type": "boolean", "description": "Top and rising related topics. Charged with the related data event when data exists.", "default": false }, "includeRegions": { "title": "Include interest by region", "type": "boolean", "description": "Ranked list of regions where the keyword is most searched. Charged as an extra event when data exists.", "default": false }, "regionResolution": { "title": "Region detail", "enum": [ "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Granularity of the regional breakdown.", "default": "REGION" }, "language": { "title": "Interface language", "type": "string", "description": "Language of labels and related queries, e.g. en-US, de, it.", "default": "en-US" }, "maxKeywords": { "title": "Max keywords per run", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety limit.", "default": 500 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Each retry uses a new session and IP.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxies are recommended on the Apify platform: Google blocks most datacenter IPs." } } }, "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 } } } } } } } } } }