{ "openapi": "3.0.1", "info": { "title": "CA Data Broker Registry Evidence Pack", "description": "Normalize the CPPA Data Broker Registry and create public-page evidence packs for privacy policy, opt-out/delete, CCPA/GPC, noindex, broken-page, request-metric, and diff monitoring signals.", "version": "0.3", "x-build-id": "Yt2O0ICezaxEZPkvl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/substitute99~ca-data-broker-evidence-pack/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-substitute99-ca-data-broker-evidence-pack", "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/substitute99~ca-data-broker-evidence-pack/runs": { "post": { "operationId": "runs-sync-substitute99-ca-data-broker-evidence-pack", "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/substitute99~ca-data-broker-evidence-pack/run-sync": { "post": { "operationId": "run-sync-substitute99-ca-data-broker-evidence-pack", "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": { "mode": { "title": "Run mode", "enum": [ "evidence_pack", "registry_snapshot", "diff_since_last_run" ], "type": "string", "description": "Choose a registry snapshot, evidence-pack scan, or diff against the previous saved snapshot.", "default": "evidence_pack" }, "registryUrl": { "title": "CPPA registry CSV URL", "type": "string", "description": "Defaults to the public CPPA data broker registry CSV.", "default": "https://cppa.ca.gov/data_broker_registry/registry.csv" }, "maxBrokers": { "title": "Max brokers", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stops after this many registry rows to control spend and run time.", "default": 100 }, "includePageScan": { "title": "Scan broker pages", "type": "boolean", "description": "When enabled, fetches public broker pages and extracts privacy/opt-out/delete/GPC/noindex evidence. Ignored in registry_snapshot mode." }, "includeDomains": { "title": "Only include domains", "type": "array", "description": "Optional domain allow-list for targeted validation runs. Matches exact domains and subdomains, so example.com also includes www.example.com. Leave empty for registry order.", "items": { "type": "string", "pattern": "^(?:[^.\\s/:]+(?:\\.[^.\\s/:]+)+\\.?|https?:\\/\\/[^.\\s/:]+(?:\\.[^.\\s/:]+)+(?:\\/\\S*)?)$" }, "default": [] }, "scanConcurrency": { "title": "Scan concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of brokers scanned in parallel.", "default": 5 }, "maxPagesPerBroker": { "title": "Max pages per broker", "minimum": 1, "maximum": 10, "type": "integer", "description": "Bounds public-page fetches per broker. Initial URLs are the primary website and CA consumer-rights URL, then discovered evidence links.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 60, "type": "integer", "description": "Per-page HTTP timeout.", "default": 20 }, "diffPreviousSnapshotId": { "title": "Previous snapshot ID", "type": "string", "description": "Optional key-value store record name for diff mode. Defaults to the latest saved evidence-pack snapshot." } } }, "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 } } } } } } } } } }