{ "openapi": "3.0.1", "info": { "title": "Share of Search Tracker: Brand vs Competitors (Google Trends)", "description": "Track your brand's share of search against every competitor. Share of search tracks market share and can lead it. Up to 100 brands on one Google Trends scale, by month, quarter or year, with the change since the last period. JSON plus a ready CSV table.", "version": "0.1", "x-build-id": "05YAslQ24VxVskUMu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alhadikhan~share-of-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alhadikhan-share-of-search", "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/alhadikhan~share-of-search/runs": { "post": { "operationId": "runs-sync-alhadikhan-share-of-search", "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/alhadikhan~share-of-search/run-sync": { "post": { "operationId": "run-sync-alhadikhan-share-of-search", "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": [ "brands" ], "properties": { "brands": { "title": "Your brand and its competitors", "type": "array", "description": "2 to 100 brand names in the same category. If a name is ambiguous, add the kind of business in brackets, for example 'Jaguar (car make)'. To pin a brand to an exact Google topic, write Name=ID, with the /m/... or /g/... ID copied from the Google Trends address bar.", "items": { "type": "string" } }, "geo": { "title": "Market (location)", "type": "string", "description": "Two-letter country code (US, GB, DE, BD) or region code (US-CA). Share of search is most useful per market. Leave empty for worldwide.", "default": "" }, "timeframe": { "title": "Time range", "type": "string", "description": "Same format as Google Trends: 'today 12-m', 'today 5-y', 'all' (since 2004), or a date range such as '2022-01-01 2026-10-31'.", "default": "today 5-y" }, "period": { "title": "Report share per", "enum": [ "month", "quarter", "year", "auto" ], "type": "string", "description": "Group the data into these periods before computing shares. Longer periods are steadier.", "default": "month" }, "matchTopics": { "title": "Use Google topics instead of brand names", "type": "boolean", "description": "Off (recommended): every brand's plain name is measured, the classic share-of-search method. Use Category to cut out other meanings. On: a Google topic is used where one clearly fits. Brands measured in different ways can bias shares; the output warns you if that happens.", "default": false }, "category": { "title": "Category ID", "minimum": 0, "type": "integer", "description": "Optional. Limits searches to one Google category, for brands whose name is also a common word (Apple, Jaguar, Shell). It can change shares a lot, because Google files some brands' searches into categories better than others'. Examples: 390 Mobile Phones, 47 Autos & Vehicles, 5 Computers & Electronics, 37 Banking, 38 Insurance, 918 Fast Food, 68 Apparel. 0 means all searches (the classic method).", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Google rate-limits data-centre IPs hard. Residential proxies are strongly recommended.", "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 } } } } } } } } } }