{ "openapi": "3.0.1", "info": { "title": "Google Trends Planner: Seasonality, Regions & Rising Searches", "description": "Google Trends for media buyers: up to thousands of keywords per run on one comparable scale, with seasonality by month, YoY and 3-month change, top regions and rising searches as flat rows. Fails loudly, never returns a silent empty dataset.", "version": "0.1", "x-build-id": "rROedsBYzj78gRYm3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hypaethral_bradawl~google-trends-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hypaethral_bradawl-google-trends-planner", "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/hypaethral_bradawl~google-trends-planner/runs": { "post": { "operationId": "runs-sync-hypaethral_bradawl-google-trends-planner", "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/hypaethral_bradawl~google-trends-planner/run-sync": { "post": { "operationId": "run-sync-hypaethral_bradawl-google-trends-planner", "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 Trends topic ids such as /m/019sbn). Duplicates are removed. With 'Compare keywords' on, the FIRST keyword anchors the scale for all others, so put your main term first.", "items": { "type": "string" } }, "geo": { "title": "Region", "type": "string", "description": "Empty = worldwide. Country code (US, GB, TH, AU...) or subregion (US-CA, GB-ENG, AU-NSW).", "default": "" }, "timeRange": { "title": "Time range", "enum": [ "today 5-y", "today 12-m", "today 3-m", "today 1-m", "now 7-d", "now 1-d", "now 4-H", "now 1-H", "all" ], "type": "string", "description": "Preset period. Use 5 years (default) to get year-over-year change and a reliable seasonality index. Ignored when a custom start date is set.", "default": "today 5-y" }, "startDate": { "title": "Custom start date", "type": "string", "description": "Optional YYYY-MM-DD (2004-01-01 or later). Overrides the time range." }, "endDate": { "title": "Custom end date", "type": "string", "description": "Optional YYYY-MM-DD; defaults to today when a start date is set." }, "searchProperty": { "title": "Search type", "enum": [ "web", "froogle", "youtube", "images", "news" ], "type": "string", "description": "Which Google surface the interest comes from. Shopping = Google Shopping searches, the closest proxy for purchase intent.", "default": "web" }, "category": { "title": "Category id", "minimum": 0, "type": "integer", "description": "Optional Trends category id to disambiguate (0 = all categories; e.g. 18 Shopping, 71 Food & Drink, 47 Autos & Vehicles, 67 Travel).", "default": 0 }, "compareKeywords": { "title": "Add share of search (all keywords on one scale)", "type": "boolean", "description": "Every keyword is always analysed on its own 0-100 scale (full precision for seasonality and change). On: also adds a shareOfSearch column putting all keywords on ONE scale; beyond 5 keywords the first keyword anchors every batch, so values can exceed 100. No extra charge.", "default": true }, "includeTimeline": { "title": "Include timeline rows", "type": "boolean", "description": "One row per keyword per week/day/hour. Turn off if you only need the summary rows.", "default": true }, "timelineGranularity": { "title": "Timeline granularity", "enum": [ "AUTO", "NATIVE" ], "type": "string", "description": "AUTO keeps a 5-year timeline at 60 monthly rows. NATIVE gives every Google data point (e.g. 261 weekly rows over 5 years); rows beyond 120 per keyword are billed as extra rows. Summary metrics always use the full-resolution data.", "default": "AUTO" }, "includeRegions": { "title": "Include interest by region", "type": "boolean", "description": "Interest by country, state, US metro (DMA) or city: one row per region.", "default": true }, "regionResolution": { "title": "Region level", "enum": [ "AUTO", "COUNTRY", "REGION", "DMA", "CITY" ], "type": "string", "description": "AUTO = countries for worldwide, states/provinces for a country, cities for a subregion. DMA (US metro areas) works for US only.", "default": "AUTO" }, "maxRegions": { "title": "Max regions per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Top regions kept as REGION rows (highest interest first). US metros (DMA) have 210; cities can be many more.", "default": 25 }, "includeRelatedQueries": { "title": "Include related queries (top + rising)", "type": "boolean", "description": "Top and rising related searches for each keyword, with Breakout flags.", "default": true }, "includeRelatedTopics": { "title": "Include related topics (top + rising)", "type": "boolean", "description": "Off by default: as of Oct 2026 Google Trends returns empty related-topic lists. Turn on to request them anyway; the summary says when Google returned none.", "default": false }, "maxRelatedPerKeyword": { "title": "Max related rows per list", "minimum": 1, "maximum": 50, "type": "integer", "description": "Cap per keyword for each of the top and rising lists (1-50).", "default": 10 }, "maxKeywords": { "title": "Max keywords", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on keywords processed in this run. You are charged only for keywords that return data; up to 120 detail rows per keyword are included, rows beyond that are $0.01 per 1,000.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google Trends rate-limits shared datacenter IPs heavily; residential is the reliable default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }