{ "openapi": "3.0.1", "info": { "title": "ShareASale Affiliate API - Merchants & Activity (BYOC)", "description": "Access ShareASale affiliate data via the official API (BYOC): merchants, coupons, deals and transaction activity reports for publishers. Bring your own API token.", "version": "1.0", "x-build-id": "UR7Ufj2z87edgiSMe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~shareasale-publisher-byoc/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-shareasale-publisher-byoc", "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/viralanalyzer~shareasale-publisher-byoc/runs": { "post": { "operationId": "runs-sync-viralanalyzer-shareasale-publisher-byoc", "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/viralanalyzer~shareasale-publisher-byoc/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-shareasale-publisher-byoc", "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": { "affiliateId": { "title": "Affiliate ID", "type": "string", "description": "Your numeric ShareASale affiliate ID (e.g. '123456'). Find it on shareasale.com > Account > Profile." }, "apiToken": { "title": "API Token", "type": "string", "description": "API token from shareasale.com > Tools > API Reporting. Public part of the credential." }, "apiSecret": { "title": "API Secret", "type": "string", "description": "API secret from shareasale.com > Tools > API Reporting. Use Version 3+ so IP whitelist is not required (Apify IPs rotate). Never logged." }, "action": { "title": "API Action", "enum": [ "merchantStatus", "merchantSearch", "couponDeals", "activity", "paymentHistory", "bannerList" ], "type": "string", "description": "Which ShareASale endpoint to call.", "default": "merchantStatus" }, "keyword": { "title": "Keyword (for merchantSearch)", "type": "string", "description": "Free-text keyword used by merchantSearch action only.", "default": "" }, "category": { "title": "Category (for merchantSearch)", "type": "string", "description": "ShareASale category filter (numeric or name, depending on API). Used by merchantSearch only.", "default": "" }, "merchantId": { "title": "Merchant ID filter", "minimum": 0, "maximum": 9999999, "type": "integer", "description": "Optional numeric merchant ID. Filters couponDeals / activity / bannerList to a single merchant.", "default": 0 }, "dateStart": { "title": "Start Date (YYYY-MM-DD)", "type": "string", "description": "Inclusive start date for activity / paymentHistory range. Format: 2026-05-01", "default": "" }, "dateEnd": { "title": "End Date (YYYY-MM-DD)", "type": "string", "description": "Inclusive end date for activity / paymentHistory range. Format: 2026-05-15", "default": "" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows to push to dataset (1-1000). The actor stops reading the API response after this many rows.", "default": 100 } } }, "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 } } } } } } } } } }