Help Center Search Gap Auditor
Pricing
from $6.50 / 1,000 search source processeds
Go to Apify Store
Help Center Search Gap Auditor
Audit help-center search snapshots for zero-result searches, weak result matches, and missing article opportunities.
Help Center Search Gap Auditor
Pricing
from $6.50 / 1,000 search source processeds
Audit help-center search snapshots for zero-result searches, weak result matches, and missing article opportunities.
You can access the Help Center Search Gap Auditor programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "Mqa0dSHIyVpUSUSAs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~help-center-search-gap-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-help-center-search-gap-auditor", "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/junipr~help-center-search-gap-auditor/runs": { "post": { "operationId": "runs-sync-junipr-help-center-search-gap-auditor", "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/junipr~help-center-search-gap-auditor/run-sync": { "post": { "operationId": "run-sync-junipr-help-center-search-gap-auditor", "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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Public help-center search result URLs to audit.", "items": { "type": "string" }, "default": [ "https://developer.mozilla.org/en-US/search?q=fetch" ] }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum public search pages or snapshots to process.", "default": 1 }, "maxDepth": { "title": "Max depth", "minimum": 0, "maximum": 3, "type": "integer", "description": "Reserved for future same-site search crawling; snapshot mode uses 0.", "default": 0 }, "includePatterns": { "title": "Include URL patterns", "type": "array", "description": "Only process URLs containing one of these strings when provided.", "items": { "type": "string" }, "default": [ "/en-US/search" ] }, "excludePatterns": { "title": "Exclude URL patterns", "type": "array", "description": "Skip URLs containing any of these strings.", "items": { "type": "string" }, "default": [ "/login", "/admin" ] }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between public fetches in milliseconds for polite crawling.", "default": 250 }, "timeoutMs": { "title": "Request timeout", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 20000 }, "maxRecords": { "title": "Max records", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum dataset rows to emit before stopping gracefully.", "default": 10 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Keep enabled for public crawling. Source-record analysis does not fetch blocked pages.", "default": true }, "redactQueryStrings": { "title": "Redact query strings", "type": "boolean", "description": "Usually false for search-gap audits because query text is core evidence.", "default": false }, "maxChargeUsd": { "title": "Max charge", "minimum": 0, "maximum": 25, "type": "number", "description": "Maximum local PPE budget before the actor stops before paid output.", "default": 25 }, "debug": { "title": "Debug", "type": "boolean", "description": "Enable extra non-secret diagnostics in logs and KVS reports.", "default": false }, "renderPages": { "title": "Render pages", "type": "boolean", "description": "Reserved for future browser rendering. Disabled by default for static search snapshots.", "default": false }, "captureScreenshots": { "title": "Capture screenshots", "type": "boolean", "description": "Reserved for future screenshot evidence. Disabled by default and no screenshot charges fire in this local pass.", "default": false }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Optional query labels when URLs or snapshots do not expose the query text.", "items": { "type": "string" }, "default": [ "fetch API" ] }, "sourceRecords": { "title": "Source records", "type": "array", "description": "Optional authorized public search-result HTML snapshots for deterministic analysis without live fetching.", "items": { "type": "object" } } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Help Center Search Gap Auditor from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: