{
"openapi": "3.0.1",
"info": {
"title": "Promo Banner Coupon Extractor",
"description": "Extract visible promo banners, coupon codes, discount claims, sale timers, free-shipping messages, and eligibility fine print from public webpages",
"version": "1.0",
"x-build-id": "YdD95E1gVKydDh3Ge"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/junipr~promo-banner-coupon-extractor/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-junipr-promo-banner-coupon-extractor",
"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/junipr~promo-banner-coupon-extractor/runs": {
"post": {
"operationId": "runs-sync-junipr-promo-banner-coupon-extractor",
"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/junipr~promo-banner-coupon-extractor/run-sync": {
"post": {
"operationId": "run-sync-junipr-promo-banner-coupon-extractor",
"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": {
"startUrls": {
"title": "startUrls",
"type": "array",
"description": "startUrls for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"sitemapUrls": {
"title": "sitemapUrls",
"type": "array",
"description": "sitemapUrls for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"htmlInputs": {
"title": "htmlInputs",
"type": "array",
"description": "htmlInputs for Promo Banner Coupon Extractor.",
"items": {
"type": "object"
},
"default": [
{
"sourceUrl": "https://shop.example",
"sourceType": "rendered",
"html": "SaleSave 25% with code SAVE25. Free shipping. Ends Friday.
"
}
]
},
"allowedDomains": {
"title": "allowedDomains",
"type": "array",
"description": "allowedDomains for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"maxPages": {
"title": "maxPages",
"minimum": 0,
"type": "integer",
"description": "maxPages for Promo Banner Coupon Extractor.",
"default": 5
},
"maxDepth": {
"title": "maxDepth",
"minimum": 0,
"type": "integer",
"description": "maxDepth for Promo Banner Coupon Extractor.",
"default": 5
},
"includeEvidence": {
"title": "includeEvidence",
"type": "boolean",
"description": "includeEvidence for Promo Banner Coupon Extractor.",
"default": false
},
"includeRawSnapshots": {
"title": "includeRawSnapshots",
"type": "boolean",
"description": "includeRawSnapshots for Promo Banner Coupon Extractor.",
"default": false
},
"requestDelayMs": {
"title": "requestDelayMs",
"minimum": 0,
"type": "integer",
"description": "requestDelayMs for Promo Banner Coupon Extractor.",
"default": 5
},
"timeoutMs": {
"title": "timeoutMs",
"minimum": 0,
"type": "integer",
"description": "timeoutMs for Promo Banner Coupon Extractor.",
"default": 5
},
"userAgentMode": {
"title": "userAgentMode",
"type": "string",
"description": "userAgentMode for Promo Banner Coupon Extractor.",
"default": ""
},
"pageUrls": {
"title": "pageUrls",
"type": "array",
"description": "pageUrls for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"couponPatterns": {
"title": "couponPatterns",
"type": "array",
"description": "couponPatterns for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"promoTerms": {
"title": "promoTerms",
"type": "array",
"description": "promoTerms for Promo Banner Coupon Extractor.",
"items": {
"type": "string"
},
"default": []
},
"includeFinePrint": {
"title": "includeFinePrint",
"type": "boolean",
"description": "includeFinePrint for Promo Banner Coupon Extractor.",
"default": false
},
"captureBannerPosition": {
"title": "captureBannerPosition",
"type": "boolean",
"description": "captureBannerPosition for Promo Banner Coupon Extractor.",
"default": false
},
"maxBannersPerPage": {
"title": "maxBannersPerPage",
"minimum": 0,
"type": "integer",
"description": "maxBannersPerPage for Promo Banner Coupon Extractor.",
"default": 5
},
"captureScreenshots": {
"title": "captureScreenshots",
"type": "boolean",
"description": "captureScreenshots for Promo Banner Coupon Extractor.",
"default": false
},
"viewportWidth": {
"title": "viewportWidth",
"minimum": 0,
"type": "integer",
"description": "viewportWidth for Promo Banner Coupon Extractor.",
"default": 5
},
"viewportHeight": {
"title": "viewportHeight",
"minimum": 0,
"type": "integer",
"description": "viewportHeight for Promo Banner Coupon Extractor.",
"default": 5
},
"maxPromoRecords": {
"title": "maxPromoRecords",
"minimum": 0,
"type": "integer",
"description": "maxPromoRecords for Promo Banner Coupon Extractor.",
"default": 10
},
"maxScreenshots": {
"title": "maxScreenshots",
"minimum": 0,
"type": "integer",
"description": "maxScreenshots for Promo Banner Coupon Extractor.",
"default": 5
},
"maxBrowserPages": {
"title": "maxBrowserPages",
"minimum": 0,
"type": "integer",
"description": "maxBrowserPages for Promo Banner Coupon Extractor.",
"default": 3
},
"maxChargeUsd": {
"title": "maxChargeUsd",
"minimum": 0,
"type": "number",
"description": "maxChargeUsd for Promo Banner Coupon Extractor.",
"default": 50
},
"includeReport": {
"title": "includeReport",
"type": "boolean",
"description": "includeReport for Promo Banner Coupon Extractor.",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}