# Help Center Search Gap Auditor (`junipr/help-center-search-gap-auditor`) Actor

Audit help-center search snapshots for zero-result searches, weak result matches, and missing article opportunities.

- **URL**: https://apify.com/junipr/help-center-search-gap-auditor.md
- **Developed by:** [junipr](https://apify.com/junipr) (community)
- **Categories:** SEO tools, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $6.50 / 1,000 search source processeds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Help Center Search Gap Auditor

Audit help-center search result pages or supplied search snapshots to find unanswered support intents, zero-result searches, weak result matches, and missing article opportunities.

### What It Does

This actor analyzes public help-center search URLs or supplied search-result HTML snapshots. It records query, result count, top result URL/title, match strength, zero-result status, gap type, recommended article, priority, evidence, and cleanup recommendations.

### What It Does Not Do

- It does not bypass logins, paywalls, CAPTCHAs, access controls, or private APIs.
- It does not run browser rendering or screenshot capture by default.
- It does not invent search volume, customer demand, rankings, or private search analytics.

### Example Input

```json
{
  "startUrls": [
    "https://developer.mozilla.org/en-US/search?q=fetch"
  ],
  "maxPages": 1,
  "maxDepth": 0,
  "includePatterns": [
    "/en-US/search"
  ],
  "excludePatterns": [
    "/login",
    "/admin"
  ],
  "requestDelayMs": 250,
  "timeoutMs": 20000,
  "maxRecords": 10,
  "respectRobotsTxt": true,
  "redactQueryStrings": false,
  "maxChargeUsd": 25,
  "debug": false,
  "renderPages": false,
  "captureScreenshots": false,
  "searchQueries": [
    "fetch API"
  ]
}
```

### Output Fields

- `actorSlug`
- `runId`
- `crawlTimestamp`
- `sourceUrl`
- `pageUrl`
- `status`
- `statusCode`
- `evidence`
- `issueCode`
- `riskLevel`
- `recommendation`
- `query`
- `searchUrl`
- `resultCount`
- `topResultUrl`
- `topResultTitle`
- `matchStrength`
- `zeroResult`
- `gapType`
- `recommendedArticle`
- `priority`

### Pricing And Cost Controls

- Pricing model: Pay per event.
- Platform usage pass-through: OFF by default for static URLs and supplied snapshots. Browser, proxy, API, or LLM modes require a future explicit pass-through review.
- Default max charge: $25.00.
- Events: `actor-start`, `search-source-processed`, `search-result-record-extracted`, `search-gap-emitted`, and `executive-report-generated`.

### Reports

The actor writes summary, findings, inventory, severity, diagnostics, executive brief, and prioritized action reports to key-value storage when the report event is charged.

# Actor input Schema

## `startUrls` (type: `array`):

Public help-center search result URLs to audit.

## `maxPages` (type: `integer`):

Maximum public search pages or snapshots to process.

## `maxDepth` (type: `integer`):

Reserved for future same-site search crawling; snapshot mode uses 0.

## `includePatterns` (type: `array`):

Only process URLs containing one of these strings when provided.

## `excludePatterns` (type: `array`):

Skip URLs containing any of these strings.

## `requestDelayMs` (type: `integer`):

Delay between public fetches in milliseconds for polite crawling.

## `timeoutMs` (type: `integer`):

Per-request timeout in milliseconds.

## `maxRecords` (type: `integer`):

Maximum dataset rows to emit before stopping gracefully.

## `respectRobotsTxt` (type: `boolean`):

Keep enabled for public crawling. Source-record analysis does not fetch blocked pages.

## `redactQueryStrings` (type: `boolean`):

Usually false for search-gap audits because query text is core evidence.

## `maxChargeUsd` (type: `number`):

Maximum local PPE budget before the actor stops before paid output.

## `debug` (type: `boolean`):

Enable extra non-secret diagnostics in logs and KVS reports.

## `renderPages` (type: `boolean`):

Reserved for future browser rendering. Disabled by default for static search snapshots.

## `captureScreenshots` (type: `boolean`):

Reserved for future screenshot evidence. Disabled by default and no screenshot charges fire in this local pass.

## `searchQueries` (type: `array`):

Optional query labels when URLs or snapshots do not expose the query text.

## `sourceRecords` (type: `array`):

Optional authorized public search-result HTML snapshots for deterministic analysis without live fetching.

## Actor input object example

```json
{
  "startUrls": [
    "https://developer.mozilla.org/en-US/search?q=fetch"
  ],
  "maxPages": 1,
  "maxDepth": 0,
  "includePatterns": [
    "/en-US/search"
  ],
  "excludePatterns": [
    "/login",
    "/admin"
  ],
  "requestDelayMs": 250,
  "timeoutMs": 20000,
  "maxRecords": 10,
  "respectRobotsTxt": true,
  "redactQueryStrings": false,
  "maxChargeUsd": 25,
  "debug": false,
  "renderPages": false,
  "captureScreenshots": false,
  "searchQueries": [
    "fetch API"
  ]
}
```

# Actor output Schema

## `results` (type: `string`):

No description

## `summary` (type: `string`):

No description

## `actions` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("junipr/help-center-search-gap-auditor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("junipr/help-center-search-gap-auditor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call junipr/help-center-search-gap-auditor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,junipr/help-center-search-gap-auditor"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/CZwvpHJcaYQYBx5hF/builds/Mqa0dSHIyVpUSUSAs/openapi.json