{ "openapi": "3.0.1", "info": { "title": "Agency Evidence Pack", "description": "Builds multi-client observed snapshots and change labels from bounded public-site signal checks.", "version": "0.1", "x-build-id": "FcTPqM0r6XEM6lcjp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/checksmithcats~agency-evidence-pack/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-checksmithcats-agency-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/checksmithcats~agency-evidence-pack/runs": { "post": { "operationId": "runs-sync-checksmithcats-agency-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/checksmithcats~agency-evidence-pack/run-sync": { "post": { "operationId": "run-sync-checksmithcats-agency-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", "required": [ "clients" ], "properties": { "agencyName": { "title": "Agency name", "type": "string", "description": "Optional agency or report name shown in report headings." }, "agencyLogoUrl": { "title": "Agency logo URL", "type": "string", "description": "Optional logo URL shown as metadata only. Template editing is not supported." }, "footerNote": { "title": "Footer note", "type": "string", "description": "Optional short footer note. The boundary disclaimer remains included." }, "sampleLimit": { "title": "Sample limit per client", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum page sample passed to underlying site-signal engines.", "default": 5 }, "clients": { "title": "Clients", "minItems": 1, "maxItems": 20, "type": "array", "description": "Client sites to include. One failing client does not stop the whole pack.", "items": { "type": "object", "required": [ "name", "domain" ], "additionalProperties": false, "properties": { "name": { "title": "Client name", "type": "string", "description": "Name used to identify this client in the generated report." }, "domain": { "title": "Bare domain", "type": "string", "description": "Public bare domain such as example.com. Do not include a scheme or path." }, "siteUrl": { "title": "Public site URL", "type": "string", "description": "Optional public http(s) site URL. Defaults to https:// followed by the bare domain." }, "logoUrl": { "title": "Client logo URL", "type": "string", "description": "Optional metadata only. The Actor does not fetch or embed this URL." }, "note": { "title": "Client note", "type": "string", "description": "Optional note marker. Raw note text is not copied into diagnostic evidence rows." } } } }, "previousSnapshot": { "title": "Previous snapshot", "type": "object", "description": "Optional currentSnapshot from a prior run, used only for change labels." } } }, "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 } } } } } } } } } }