{
"openapi": "3.0.1",
"info": {
"title": "Black Friday & Holiday Promo Ad Tracker",
"description": "Track competitors' Black Friday, Cyber Monday and holiday promotions across Google Ads and Microsoft (Bing) Ads: discounts, promo codes, free shipping, sale events and deadlines pulled from the ad copy, with a promo summary per brand.",
"version": "1.0",
"x-build-id": "bd9BJNKz3T4Qrs4jw"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/weirworks~holiday-promo-ad-tracker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-weirworks-holiday-promo-ad-tracker",
"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/weirworks~holiday-promo-ad-tracker/runs": {
"post": {
"operationId": "runs-sync-weirworks-holiday-promo-ad-tracker",
"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/weirworks~holiday-promo-ad-tracker/run-sync": {
"post": {
"operationId": "run-sync-weirworks-holiday-promo-ad-tracker",
"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": {
"brands": {
"title": "Brands or domains",
"type": "array",
"description": "Competitors to track, as brand names (e.g. Best Buy) or domains (e.g. bestbuy.com). Domains are most precise.",
"items": {
"type": "string"
}
},
"platforms": {
"title": "Ad platforms",
"type": "array",
"description": "Where to look for ads.",
"items": {
"type": "string",
"enum": [
"google",
"microsoft"
],
"enumTitles": [
"Google Ads (Search, Display, YouTube)",
"Microsoft Ads (Bing; EU-served ads)"
]
},
"default": [
"google",
"microsoft"
]
},
"maxAdsPerBrand": {
"title": "Max ads scanned per brand and platform",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Newest ads first. Only promo ads are charged.",
"default": 100
},
"maxAdvertisersPerBrand": {
"title": "Advertiser accounts per brand name",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Big brands advertise from several accounts; raise this to cover them (ignored for domains on Google).",
"default": 1
},
"region": {
"title": "Country (Google)",
"type": "string",
"description": "Two-letter country code for Google ads, or anywhere.",
"default": "US"
},
"adFormat": {
"title": "Ad format (Google)",
"enum": [
"all",
"text",
"image",
"video"
],
"type": "string",
"description": "Search text ads carry most promo copy.",
"default": "all"
},
"promoAdsOnly": {
"title": "Only ads with a promotion",
"type": "boolean",
"description": "Return only ads whose copy contains a discount, code, offer, sale event or urgency. Turn off to get every ad with promo fields filled in.",
"default": true
},
"saleEvents": {
"title": "Sale events",
"type": "array",
"description": "Only ads mentioning these events, e.g. Black Friday, Cyber Monday. Leave empty for any promo.",
"items": {
"type": "string",
"enum": [
"black_friday",
"cyber_monday",
"cyber_week",
"early_access",
"thanksgiving",
"christmas",
"holiday",
"halloween",
"new_year",
"boxing_day",
"singles_day",
"prime_day",
"end_of_season",
"gift_guide"
]
}
},
"includeBrandSummary": {
"title": "Brand promo summary",
"type": "boolean",
"description": "One row per brand: ads scanned, promo ads, top discount, promo codes found, sale events and offers.",
"default": true
},
"onlyNewAds": {
"title": "Only new ads (monitoring)",
"type": "boolean",
"description": "Skip ads returned by earlier runs with the same brands. Schedule daily through BFCM.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Google blocks most shared datacenter IPs on the Transparency Center; residential is the default and its cost is included in the price.",
"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
}
}
}
}
}
}
}
}
}
}