{
"openapi": "3.0.1",
"info": {
"title": "Google Trends Bulk Keyword Comparison - 500 Keywords, 1 Scale",
"description": "Compare more than 5 keywords in Google Trends. Normalizes up to 500 keywords onto a single 0-100 scale, so search interest is directly comparable across the whole list. Rank keywords by Google Trends popularity in bulk.",
"version": "0.1",
"x-build-id": "n0liXog47ZNDYyejP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/headply~google-trends-bulk-keyword-comparison/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-headply-google-trends-bulk-keyword-comparison",
"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/headply~google-trends-bulk-keyword-comparison/runs": {
"post": {
"operationId": "runs-sync-headply-google-trends-bulk-keyword-comparison",
"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/headply~google-trends-bulk-keyword-comparison/run-sync": {
"post": {
"operationId": "run-sync-headply-google-trends-bulk-keyword-comparison",
"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": "One search term per line, up to 500. They are all returned on one comparable scale. Topic IDs such as /m/07bsy also work.",
"items": {
"type": "string"
}
},
"geos": {
"title": "Locations",
"type": "array",
"description": "Country or region codes, one per line: US, GB, US-CA (California), US-NY-501 (New York metro). Leave empty for worldwide. Each location is a separate set of results.",
"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",
"custom"
],
"type": "string",
"description": "The period to cover. Pick Custom to set exact dates below.",
"default": "today 12-m"
},
"startDate": {
"title": "Start date",
"type": "string",
"description": "First day of a custom range, from 2004-01-01."
},
"endDate": {
"title": "End date",
"type": "string",
"description": "Last day of a custom range. Leave empty for today."
},
"dailyResolution": {
"title": "Daily data for long ranges",
"type": "boolean",
"description": "Google only gives daily points for ranges up to about nine months, then switches to weekly or monthly. Turn this on to get one daily point per day over any range, even 2004 to today. Each window is calibrated against the full-range series so the levels stay consistent across years.",
"default": false
},
"includeInterestByRegion": {
"title": "Interest by region",
"type": "boolean",
"description": "Add each keyword's interest per country, state, metro or city.",
"default": false
},
"regionResolution": {
"title": "Region level",
"enum": [
"auto",
"COUNTRY",
"REGION",
"DMA",
"CITY"
],
"type": "string",
"description": "The level for interest by region. Auto uses countries for worldwide and states or provinces for a country. Metro areas are available for the US.",
"default": "auto"
},
"includeRelatedQueries": {
"title": "Related and rising queries",
"type": "boolean",
"description": "Add the top related searches and the fastest-rising ones (including Breakouts) for each keyword.",
"default": false
},
"includeTimeline": {
"title": "Include the full time series",
"type": "boolean",
"description": "Turn off if you only need the summary numbers (average, peak, latest, change).",
"default": true
},
"category": {
"title": "Category",
"minimum": 0,
"type": "integer",
"description": "Google Trends category ID to narrow the meaning of a keyword, for example 71 for Food & Drink or 12 for Business & Industrial. 0 means all categories.",
"default": 0
},
"searchProperty": {
"title": "Search type",
"enum": [
"web",
"images",
"news",
"youtube",
"shopping"
],
"type": "string",
"description": "Which Google search to measure.",
"default": "web"
},
"language": {
"title": "Language",
"type": "string",
"description": "Interface language for names of regions and topics, for example en-US or de-DE.",
"default": "en-US"
},
"maxConcurrency": {
"title": "Parallel sessions",
"minimum": 1,
"maximum": 16,
"type": "integer",
"description": "How many Google sessions run at once. Higher is faster for large keyword lists; each session uses its own IP.",
"default": 4
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Google throttles Trends per IP. Residential proxies give the most reliable results.",
"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
}
}
}
}
}
}
}
}
}
}