{ "openapi": "3.0.1", "info": { "title": "Bing Copilot Ads Scraper", "description": "Bing Copilot Ads Scraper collects the sponsored ads Bing shows in AI Mode (Copilot Search): the Related Products carousel, text ads, and image ads. See who wins AI Mode for your keywords: which stores and brands advertise, at what price and discount, in which position, and next to which answer.", "version": "0.0", "x-build-id": "itEtIScaUczbeghZ0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gytelio1~bing-copilot-ads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gytelio1-bing-copilot-ads-scraper", "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/gytelio1~bing-copilot-ads-scraper/runs": { "post": { "operationId": "runs-sync-gytelio1-bing-copilot-ads-scraper", "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/gytelio1~bing-copilot-ads-scraper/run-sync": { "post": { "operationId": "run-sync-gytelio1-bing-copilot-ads-scraper", "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": [ "queries" ], "properties": { "queries": { "title": "Queries", "uniqueItems": true, "type": "array", "description": "See which brands advertise for these queries in Bing AI Mode. A product type, like \"best vpn\" or \"best laptops for students\", shows who advertises for it. A brand alone, like \"nordvpn\" or \"dyson\", shows who advertises on its name: the brand itself, competitors, and resellers. Products and brands get the most ads; travel and insurance get few.", "items": { "type": "string" } }, "depth": { "title": "Depth", "enum": [ "quick", "standard", "deep" ], "type": "string", "description": "How many chats each query gets. Deeper finds more ads and advertisers but costs more. About $0.15 per query for Quick, $0.50 for Standard, and $1.20 for Deep, with typical ads. The number of ads depends on what Bing shows.", "default": "standard" }, "country": { "title": "Country", "enum": [ "US", "GB", "CA", "AU", "NZ", "IE", "DE", "FR", "ES", "IT", "NL", "IN", "BR", "MX", "JP", "CZ", "PL" ], "type": "string", "description": "Chats run from this country, so you see the ads shown there, in its currency.", "default": "US" }, "saveScreenshots": { "title": "Save ad proof", "type": "boolean", "description": "Save a screenshot of each turn's ads with the message that brought them, and the ads' HTML with every field Bing sent. Proof the ads were shown and what they were shown for. Linked from screenshotUrls and htmlUrl in the results. Adds a few seconds per turn with ads, no extra charge.", "default": false }, "followUpQueries": { "title": "Follow-up queries", "maxItems": 8, "type": "array", "description": "Optional. Sent in order after each query, the same for every query. Bing shows its ads on the query itself, so follow-ups rarely bring more and make each chat 30-40 seconds longer per follow-up. Each follow-up sent is charged as a Follow-up event. Up to 8.", "items": { "type": "string" } }, "includeOrganicLinks": { "title": "Include answer links", "type": "boolean", "description": "Also save the links Bing cited in its answer, to compare who pays for the spot with who Bing recommends anyway. Waits for the whole answer, so each chat takes about twice as long, and is charged an extra Answer links event.", "default": false } } }, "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 } } } } } } } } } }