{ "openapi": "3.0.1", "info": { "title": "Google Trends Keyword Ranker and Compare Tool", "description": "Rank up to 100 keywords on one comparable Google Trends scale, with interest by region and related queries, for many locations in one run.", "version": "0.2", "x-build-id": "rOcD5ctl7W49GV5VL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datagrit~google-trends-keyword-ranker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datagrit-google-trends-keyword-ranker", "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/datagrit~google-trends-keyword-ranker/runs": { "post": { "operationId": "runs-sync-datagrit-google-trends-keyword-ranker", "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/datagrit~google-trends-keyword-ranker/run-sync": { "post": { "operationId": "run-sync-datagrit-google-trends-keyword-ranker", "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", "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Keywords or topics to compare, one per line, up to 100. Lists longer than five are linked automatically so every number is on the same 0 to 100 scale. Duplicates are ignored.", "default": [ "python", "java", "rust", "golang", "kotlin", "swift", "typescript" ], "items": { "type": "string" } }, "geos": { "title": "Locations", "type": "array", "description": "Where to measure interest: a country code such as \"US\" or \"DE\", a region such as \"US-CA\" or \"GB-ENG\", or \"WORLDWIDE\". Each location is a separate comparison, up to 10 per run.", "default": [ "US" ], "items": { "type": "string" } }, "timeRange": { "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 measure. Short ranges return hourly points, long ones weekly or monthly points.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom date range", "type": "string", "description": "Optional range \"YYYY-MM-DD YYYY-MM-DD\", start date first, for example \"2024-01-01 2024-12-31\". When filled it replaces the time range above.", "default": "" }, "searchType": { "title": "Search type", "enum": [ "web", "images", "news", "youtube", "shopping" ], "type": "string", "description": "Which Google property the searches come from.", "default": "web" }, "category": { "title": "Category ID", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional Google Trends category number that narrows the searches, for example 5 for Computers and Electronics. 0 means all categories.", "default": 0 }, "dataTypes": { "title": "Data to return", "type": "array", "description": "Row types to produce, one per line: keywordSummary (one ranked row per keyword and location), interestOverTime (one row per keyword and location with the whole timeline in one field), interestByRegion and relatedQueries (both read per keyword). Unknown values are ignored.", "default": [ "keywordSummary" ], "items": { "type": "string" } }, "regionResolution": { "title": "Region detail", "enum": [ "auto", "city", "metro" ], "type": "string", "description": "Granularity of the interest by region rows: automatic picks countries for worldwide runs and states or provinces for a country; cities and metro areas give finer rows inside a country, and Google reports only cities with enough search volume, so rare keywords may return few or none.", "default": "auto" }, "maxRegionsPerKeyword": { "title": "Regions per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Keep this many top regions for each keyword and location.", "default": 25 }, "relatedQueryKind": { "title": "Related queries to return", "enum": [ "both", "top", "rising" ], "type": "string", "description": "Top queries are the most searched alongside the keyword; rising queries grew fastest and include breakout flags.", "default": "both" }, "maxRelatedPerKeyword": { "title": "Related queries per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Keep this many related queries of each kind for each keyword and location.", "default": 25 }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows in total across all keywords and locations.", "default": 200 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Google Trends rate limits shared server addresses, so Apify Proxy is on by default. Switch it off only when you run the Actor from a home connection.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }