{ "openapi": "3.0.1", "info": { "title": "Email Deliverability Portfolio Audit API", "description": "Audit SPF, DKIM, DMARC, MTA-STS, TLS-RPT, BIMI, and sender-readiness signals across domain portfolios with executive summaries and remediation guidance.", "version": "0.1", "x-build-id": "UYLb9nBxkAPMUY17v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~email-deliverability-portfolio-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-email-deliverability-portfolio-audit", "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/taroyamada~email-deliverability-portfolio-audit/runs": { "post": { "operationId": "runs-sync-taroyamada-email-deliverability-portfolio-audit", "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/taroyamada~email-deliverability-portfolio-audit/run-sync": { "post": { "operationId": "run-sync-taroyamada-email-deliverability-portfolio-audit", "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": [ "domains" ], "properties": { "domains": { "title": "Free / starter: Domains to audit", "type": "array", "description": "Start with 2-3 domains for the first deliverability baseline. Expand later into larger recurring portfolios while keeping the same summary-first workflow.", "items": { "type": "string" } }, "followRedirects": { "title": "Follow redirects for sender-readiness checks", "type": "boolean", "description": "Follow redirects when checking the main HTTPS endpoint and the MTA-STS policy URL.", "default": true }, "checkDkim": { "title": "Check DKIM selectors", "type": "boolean", "description": "Probe a small set of common selectors so the first run catches missing DKIM posture quickly.", "default": true }, "dkimSelectors": { "title": "Custom DKIM selectors", "type": "array", "description": "Optional custom DKIM selectors to probe instead of the built-in defaults.", "items": { "type": "string" } }, "checkBimi": { "title": "Check BIMI", "type": "boolean", "description": "Optional branding readiness check. Missing BIMI is treated as an opportunity signal, not a hard failure.", "default": true }, "delivery": { "title": "Delivery mode (starter dataset vs webhook)", "enum": [ "dataset", "webhook" ], "type": "string", "description": "Dataset mode keeps the first run lightweight while still writing the full executive summary to OUTPUT. Webhook mode sends the same summary, alert queue, and per-domain rows to your endpoint.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Required when delivery=webhook." }, "snapshotKey": { "title": "Snapshot key for recurring audits", "type": "string", "description": "Reuse the same key when you move from the starter baseline to recurring monitoring so policy changes stay comparable.", "default": "email-deliverability-portfolio-audit" }, "concurrency": { "title": "Parallel domain checks", "minimum": 1, "maximum": 10, "type": "integer", "description": "Starter runs usually only need 2-3. Increase carefully for larger portfolios.", "default": 3 }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Preview the full summary without saving snapshots, dataset rows, or webhooks.", "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 } } }, "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 } } } } } } } } } }