{ "openapi": "3.0.1", "info": { "title": "Google Trends API: Over Time, by Region, Related & Trending", "version": "0.1", "x-build-id": "w8RhvJTb4fIuStmGs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sauliusautomatesit~google-trends-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sauliusautomatesit-google-trends-api", "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/sauliusautomatesit~google-trends-api/runs": { "post": { "operationId": "runs-sync-sauliusautomatesit-google-trends-api", "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/sauliusautomatesit~google-trends-api/run-sync": { "post": { "operationId": "run-sync-sauliusautomatesit-google-trends-api", "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": { "mode": { "title": "Mode", "enum": [ "keywordReport", "compare", "trendingNow" ], "type": "string", "description": "Keyword report: interest over time, by region and related queries for each keyword on its own. Compare: interest over time for all your keywords on one shared 0-100 scale (any number of keywords). Trending now: today's trending searches per country.", "default": "keywordReport" }, "keywords": { "title": "Keywords", "type": "array", "description": "One keyword or phrase per line, up to 5,000 per run. Not used in Trending now mode.", "items": { "type": "string" } }, "geo": { "title": "Country or region", "type": "string", "description": "Two-letter country code (US, GB, DE), a region such as US-CA, or empty for worldwide.", "default": "US" }, "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 cover. Short ranges give hourly or minute points; 5 years and all-time give weekly or monthly points.", "default": "today 12-m" }, "customTimeRange": { "title": "Custom time range (optional)", "type": "string", "description": "Overrides Time range. Format: \"YYYY-MM-DD YYYY-MM-DD\", e.g. \"2025-01-01 2025-12-31\"." }, "property": { "title": "Google property", "enum": [ "web", "images", "news", "shopping", "youtube" ], "type": "string", "description": "Which Google search to measure.", "default": "web" }, "category": { "title": "Category ID", "minimum": 0, "type": "integer", "description": "Google Trends category number, 0 for all categories. Examples: 7 Finance, 18 Shopping, 45 Health, 71 Food & Drink.", "default": 0 }, "dataTypes": { "title": "Data in each keyword report", "type": "array", "description": "Keyword report mode only. Fewer data types make runs faster; the price per keyword is the same.", "items": { "type": "string", "enum": [ "interestOverTime", "interestByRegion", "relatedQueries" ], "enumTitles": [ "Interest over time", "Interest by region", "Related queries" ] }, "default": [ "interestOverTime", "interestByRegion", "relatedQueries" ] }, "resolution": { "title": "Region detail", "enum": [ "auto", "COUNTRY", "REGION", "CITY", "DMA" ], "type": "string", "description": "Level of interest by region. Automatic means countries for worldwide and regions (states) for a country. Metro (DMA) is US only.", "default": "auto" }, "maxRelated": { "title": "Max related queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Per list (top and rising) per keyword.", "default": 25 }, "anchorKeyword": { "title": "Anchor keyword (compare mode)", "type": "string", "description": "Compare mode: the keyword repeated in every batch of 5 to put all keywords on one scale. Pick a steady, mid-popularity term. Defaults to your first keyword." }, "trendingGeos": { "title": "Countries (trending now mode)", "type": "array", "description": "Two-letter country codes, one per line. Defaults to the Country field.", "items": { "type": "string" } }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "Keywords fetched in parallel. Higher is faster but more likely to hit Google's rate limits.", "default": 3 }, "allowResidential": { "title": "Use residential proxy fallback", "type": "boolean", "description": "When datacenter IPs are rate-limited, retry through residential proxies. Included in the price.", "default": 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 } } } } } } } } } }