{ "openapi": "3.0.1", "info": { "title": "Structured Data Competitor Gap Prioritizer", "description": "Prioritize supplied structured-data competitor gaps with transparent impact, effort, confidence, and equal-domain coverage math.", "version": "0.1", "x-build-id": "LafQ4S6rCR9AjRSUl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~structured-data-competitor-gap-prioritizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-structured-data-competitor-gap-prioritizer", "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/zinin~structured-data-competitor-gap-prioritizer/runs": { "post": { "operationId": "runs-sync-zinin-structured-data-competitor-gap-prioritizer", "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/zinin~structured-data-competitor-gap-prioritizer/run-sync": { "post": { "operationId": "run-sync-zinin-structured-data-competitor-gap-prioritizer", "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": [ "schemaVersion", "assessmentId", "targetDomain", "competitorDomains", "opportunities" ], "properties": { "schemaVersion": { "title": "Schema version", "enum": [ "1.0" ], "type": "string", "description": "Use version 1.0 for this prioritization contract." }, "assessmentId": { "title": "Assessment ID", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$", "minLength": 1, "maxLength": 64, "type": "string", "description": "Enter a stable identifier for this planning assessment, such as q3-2026." }, "targetDomain": { "title": "Target domain", "pattern": "^[a-z0-9](?:[a-z0-9.-]{0,251}[a-z0-9])?$", "minLength": 1, "maxLength": 253, "type": "string", "description": "Enter the canonical registrable domain whose structured-data opportunities you want to prioritize." }, "competitorDomains": { "title": "Competitor domains", "minItems": 1, "maxItems": 10, "uniqueItems": true, "type": "array", "description": "Enter 1 to 10 canonical registrable competitor domains in the same order used by every competitor coverage array.", "items": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9.-]{0,251}[a-z0-9])?$", "minLength": 1, "maxLength": 253 } }, "opportunities": { "title": "Structured-data opportunities", "minItems": 1, "maxItems": 8, "type": "array", "description": "Supply 1 to 8 unique fixed opportunities with target coverage, one position-paired competitor value per declared domain, and your explicit planning weights.", "items": { "type": "object", "additionalProperties": false, "properties": { "opportunityCode": { "title": "Opportunity code", "description": "Choose one fixed structured-data workstream.", "type": "string", "editor": "select", "enum": [ "ORGANIZATION_IDENTITY", "PRODUCT_OFFER", "ARTICLE_PROVENANCE", "LOCAL_BUSINESS_DETAILS", "BREADCRUMB_NAVIGATION", "REVIEW_RATING", "VIDEO_METADATA", "JOB_POSTING_DETAILS" ], "enumTitles": [ "Organization identity", "Product and offer", "Article provenance", "Local business details", "Breadcrumb navigation", "Review and rating", "Video metadata", "Job posting details" ] }, "targetCoverageBps": { "title": "Target coverage (bps)", "description": "Enter target coverage from 0 to 10000 basis points.", "type": "integer", "editor": "number", "minimum": 0, "maximum": 10000 }, "competitorCoverageBps": { "title": "Competitor coverage (bps)", "description": "Enter one 0 to 10000 basis-point value for every competitor domain, in declared domain order.", "type": "array", "editor": "json", "minItems": 1, "maxItems": 10, "items": { "type": "integer", "minimum": 0, "maximum": 10000 } }, "businessImpact": { "title": "Business impact", "description": "Rate declared business impact from 1 low to 5 high.", "type": "integer", "editor": "number", "minimum": 1, "maximum": 5 }, "implementationEffort": { "title": "Implementation effort", "description": "Rate declared implementation effort from 1 low to 5 high.", "type": "integer", "editor": "number", "minimum": 1, "maximum": 5 }, "evidenceConfidence": { "title": "Evidence confidence", "description": "Choose your confidence in the supplied coverage comparison.", "type": "string", "editor": "select", "enum": [ "LOW", "MEDIUM", "HIGH" ], "enumTitles": [ "Low", "Medium", "High" ] }, "affectedTargetPages": { "title": "Affected target pages", "description": "Enter the declared number of target pages in this workstream.", "type": "integer", "editor": "number", "minimum": 1, "maximum": 10000 } }, "required": [ "opportunityCode", "targetCoverageBps", "competitorCoverageBps", "businessImpact", "implementationEffort", "evidenceConfidence", "affectedTargetPages" ] } }, "minimumGapBps": { "title": "Minimum competitor gap (bps)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Require at least this target-below-competitor median gap before a candidate can enter the selected queue.", "default": 1000 }, "maxPriorities": { "title": "Maximum selected priorities", "minimum": 1, "maximum": 8, "type": "integer", "description": "Select the first 1 to 8 eligible candidates after deterministic ordering; every supplied candidate still appears in the plan.", "default": 3 } } }, "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 } } } } } } } } } }