{ "openapi": "3.0.1", "info": { "title": "Data Coverage Claim Verifier", "description": "Tests a vendor's explicit coverage claim against an authorized buyer reference set and returns PASS, FAIL, or UNKNOWN with reproducible evidence.", "version": "1.0", "x-build-id": "yngSX5YncRPCJEdRo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/boundedtools~data-coverage-claim-verifier/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-boundedtools-data-coverage-claim-verifier", "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/boundedtools~data-coverage-claim-verifier/runs": { "post": { "operationId": "runs-sync-boundedtools-data-coverage-claim-verifier", "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/boundedtools~data-coverage-claim-verifier/run-sync": { "post": { "operationId": "run-sync-boundedtools-data-coverage-claim-verifier", "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": [ "mode" ], "properties": { "mode": { "title": "Run mode", "enum": [ "free_example", "private_audit" ], "type": "string", "description": "free_example ignores all private audit fields and uses bundled synthetic data. private_audit validates and audits your manifest.", "default": "free_example" }, "claim": { "title": "Exact vendor claim", "required": [ "statement", "metric", "threshold" ], "type": "object", "description": "The quoted claim and the numerical threshold being tested. Only at_least coverage claims are supported.", "properties": { "statement": { "type": "string", "title": "Claim statement", "description": "The vendor's exact quoted or contracted coverage statement.", "maxLength": 2000 }, "metric": { "type": "string", "title": "Metric", "description": "Test keyed entity coverage or presence of one claimed field on matched entities.", "enum": [ "entity_coverage", "field_presence" ] }, "fieldPath": { "type": "string", "title": "Claimed vendor field (field_presence only)", "description": "Safe dotted path to the vendor field whose non-empty presence was claimed." }, "comparator": { "type": "string", "title": "Comparator", "description": "Version 1 supports lower-bound claims only.", "enum": [ "at_least" ] }, "threshold": { "type": "number", "title": "Coverage threshold", "description": "Claimed minimum proportion from 0 through 1.", "minimum": 0, "maximum": 1 }, "aggregation": { "type": "string", "title": "Evaluate", "description": "Apply the threshold overall or require every reported stratum to pass.", "enum": [ "overall", "all_strata" ] } }, "additionalProperties": false }, "population": { "title": "Tested population", "required": [ "description", "basis" ], "type": "object", "description": "Declare whether the supplied reference is the complete buyer-defined set or a representative sample of a larger population.", "properties": { "description": { "type": "string", "title": "Population description", "description": "Human-readable definition of the exact market, segment, and eligibility boundary being tested.", "maxLength": 2000 }, "basis": { "type": "string", "title": "Reference basis", "description": "Declare a complete buyer-defined set for direct measurement or a representative sample for inference.", "enum": [ "complete_reference_set", "representative_sample" ] } }, "additionalProperties": false }, "referenceSource": { "title": "Buyer/reference source", "type": "object", "description": "An inline record array, an explicitly allowlisted HTTPS JSON/JSONL/CSV URL, an Apify Dataset, or an Apify key-value record.", "properties": { "datasetId": { "title": "Reference Dataset", "type": "string", "description": "Apify Dataset ID or name to read when type is apify_dataset.", "editor": "resourcePicker", "resourceType": "dataset", "resourcePermissions": [ "READ" ] }, "storeId": { "title": "Reference key-value store", "type": "string", "description": "Apify key-value store ID or name to read when type is apify_kv_record.", "editor": "resourcePicker", "resourceType": "keyValueStore", "resourcePermissions": [ "READ" ] } } }, "vendorSource": { "title": "Vendor/tested source", "type": "object", "description": "An inline record array, an explicitly allowlisted HTTPS JSON/JSONL/CSV URL, an Apify Dataset, or an Apify key-value record.", "properties": { "datasetId": { "title": "Vendor Dataset", "type": "string", "description": "Apify Dataset ID or name to read when type is apify_dataset.", "editor": "resourcePicker", "resourceType": "dataset", "resourcePermissions": [ "READ" ] }, "storeId": { "title": "Vendor key-value store", "type": "string", "description": "Apify key-value store ID or name to read when type is apify_kv_record.", "editor": "resourcePicker", "resourceType": "keyValueStore", "resourcePermissions": [ "READ" ] } } }, "matching": { "title": "Deterministic matching rule", "type": "object", "description": "Parallel referenceKeys and vendorKeys arrays define one exact or composite join key. No fuzzy or AI matching is performed." }, "strata": { "title": "Optional strata", "maxItems": 5, "type": "array", "description": "Up to five reference fields to report separately, for example market or company size.", "items": { "type": "object", "additionalProperties": false, "required": [ "name", "referenceField" ], "properties": { "name": { "type": "string", "title": "Stratum name", "description": "Stable label used in output, such as market." }, "referenceField": { "type": "string", "title": "Reference field", "description": "Safe dotted path in reference records used to form groups." } } } }, "sampling": { "title": "Optional deterministic sampling", "type": "object", "description": "Cap tested reference records and set the stable sampling seed. Maximum 20,000 tested records." }, "uncertainty": { "title": "Optional uncertainty rules", "type": "object", "description": "Wilson confidence intervals apply to representative or downsampled tests; complete reference sets are measured directly." }, "rightsAttestation": { "title": "Required rights attestation", "type": "object", "description": "You must have the right to audit both supplied sources, must not bypass access controls, and must minimize the data supplied." }, "evidence": { "title": "Optional counterexample output", "type": "object", "description": "Identifiers are hashed by default. Raw join keys require explicit counterexample-output authorization." }, "commercialRules": { "title": "Optional commercial decision rules", "type": "object", "description": "Optional loss thresholds used only for the separate buy/test_more/negotiate_or_discount/reject suggestion." }, "auditContext": { "title": "Optional repeat-audit context", "type": "object", "description": "A non-personal datasetVersion label supports version-repeat measurement; only its SHA-256 fingerprint is output." }, "retention": { "title": "Optional input retention", "type": "object", "description": "By default the Actor deletes the run INPUT record after loading it. Set retainInput=true only if you explicitly want Apify run storage to keep it under your account retention settings." } } }, "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 } } } } } } } } } }