# KB Search Query Tester (`junipr/kb-search-query-tester`) Actor Test public knowledge base search queries and evaluate whether expected articles, titles, keywords, or categories appear in the top results. - **URL**: https://apify.com/junipr/kb-search-query-tester.md - **Developed by:** [junipr](https://apify.com/junipr) (community) - **Categories:** Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $4.90 / 1,000 page auditeds 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/platform/actors/running/actors-in-store#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 ## KB Search Query Tester ### Store Positioning **Store title:** KB Search Query Tester **Short description:** Test public knowledge base search queries and evaluate whether expected articles, titles, keywords, or categories appear in the top results. **SEO title:** KB Search Query Tester — technical SEO, web, and domain audit **SEO description:** Test public knowledge base search queries and evaluate whether expected articles, titles, keywords, or categories appear in the top results. Use it to find crawlability, indexability, security, metadata, and page-quality issues with evidence-backed rows and audit reports. **Categories:** DEVELOPER\_TOOLS **Keywords:** kb, search, query, tester, public data, web/domain audit ### Pay-Per-Event Pricing This actor uses pay-per-event pricing. Event prices include Apify platform usage; users are not expected to pay a separate platform-usage pass-through charge for the configured pricing model. - Tier: W1 — Web/domain audit - Primary event: `page-audited` at $0.00490 base - Default max charge: $10.00 - Store discounts: FREE/BRONZE base, SILVER discounted, GOLD deepest approved discount Event set: - `actor-start`: base $0.00500, GOLD $0.00400. Kb Search Query Tester: charged when actor start is completed. The price includes Apify platform usage; no separate usage pass-through is intended. - `page-audited`: base $0.00490, GOLD $0.00392. Kb Search Query Tester: charged when page audited is completed. The price includes Apify platform usage; no separate usage pass-through is intended. - `record-extracted`: base $0.00372, GOLD $0.00298. Kb Search Query Tester: charged when record extracted is completed. The price includes Apify platform usage; no separate usage pass-through is intended. - `finding-emitted`: base $0.00372, GOLD $0.00298. Kb Search Query Tester: charged when finding emitted is completed. The price includes Apify platform usage; no separate usage pass-through is intended. - `audit-report-generated`: base $0.05000, GOLD $0.04000. Kb Search Query Tester: charged when audit report generated is completed. The price includes Apify platform usage; no separate usage pass-through is intended. The actor accepts `actor-start` before work, accepts the primary event before each dataset row, and accepts the configured report event before writing report files. If `maxChargeUsd` or the live PPE limit blocks a charge, the corresponding row or report is not written. ### Public Task Concepts - Audit KB Search Query Tester controls on a capped public sample - Find high-priority KB Search Query Tester issues before release - Validate KB Search Query Tester evidence from supplied pages - Prioritize KB Search Query Tester fixes with severity and proof - Export KB Search Query Tester QA rows for client review Test public knowledge base search queries and evaluate whether expected articles, titles, keywords, or categories appear in the top results. ### What it does - Accept help center base URL, search endpoint URL, configured search query list, expected URLs/titles/keywords, and selectors. - Run public search queries with polite rate limits. - Extract result rank, URL, title, snippet, category hints, and match status. - Score query coverage using expected result rules. - Detect zero-result searches, weak top result matches, duplicate results, and result drift. - Generate a search QA report for support teams. ### What it does not do - No private support search, login-required results, search ranking manipulation, automated search spam, or scraping personal support tickets. - No guarantee that a query “should” rank without user-provided expectations. ### Input fields Primary inputs from the locked actor spec: `helpCenterBaseUrl`, `searchUrlTemplate`, `queries`, `expectedResults`, `expectedKeywords`, `resultSelectors`, `locale`, `maxResultsPerQuery`, `requestDelayMs`, `includeSnippets`, `failOnMissingExpected`, `timeoutMs`. `maxChargeUsd` keeps runs capped during production use. ### Output fields Dataset rows include: `query`, `locale`, `searchUrl`, `resultRank`, `resultUrl`, `resultTitle`, `resultSnippet`, `categoryHint`, `matchedExpected`, `expectedUrl`, `expectedKeywordMatches`, `score`, `issueCode`, `warning`. ### Starter example Use `examples/input.tiny.json` as a small starter input. Keep the first run capped and review the dataset before increasing limits. ### Public task examples - Run KB Search Query Tester on supplied sample data: Run KB Search Query Tester on supplied sample data using a small bounded input. - Generate a KB Search Query Tester QA report: Generate a KB Search Query Tester QA report using a small bounded input. - Find invalid rows with KB Search Query Tester: Find invalid rows with KB Search Query Tester using a small bounded input. - Create a capped local endpoint readiness check for KB Search Query Tester: Create a capped local endpoint readiness check for KB Search Query Tester using a small bounded input. - Prepare KB Search Query Tester output for downstream automation: Prepare KB Search Query Tester output for downstream automation using a small bounded input. ### Public source provenance The starter input tests Zendesk's public help-center search for `getting started` and checks for the public article at `https://support.zendesk.com/hc/en-us/articles/4408884056346-Introduction-Getting-started-with-Zendesk-Support`. ### Reports - `kb-search-query-test-report.md` - `query-result-matrix.csv` - `missing-expected-results.json` - `zero-result-queries.csv` - `search-quality-summary.json` ### Limitations and safe use Start with supplied-input runs, then enable live endpoints only with tight caps, domain allowlists, and no secrets in public examples. # Actor input Schema ## `helpCenterBaseUrl` (type: `string`): Public help center base URL to fetch or inspect for KB Search Query Tester. ## `searchUrlTemplate` (type: `string`): Search URL Template controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs. ## `queries` (type: `array`): Search queries to run against the configured source or supplied content. ## `expectedResults` (type: `object`): Expected results used for comparison and validation. ## `expectedKeywords` (type: `object`): Expected keywords used for comparison and validation. ## `resultSelectors` (type: `object`): Selectors used to locate result in supplied or fetched HTML. ## `locale` (type: `string`): Locale controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs. ## `maxResultsPerQuery` (type: `number`): Maximum results per query to process in one run; keep defaults low for safe first runs. ## `requestDelayMs` (type: `number`): Request Delay ms controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs. ## `includeSnippets` (type: `boolean`): Include snippets in output rows or reports when available. ## `failOnMissingExpected` (type: `boolean`): Fail On Missing Expected controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs. ## `timeoutMs` (type: `number`): Maximum time in milliseconds allowed for the KB Search Query Tester operation before it is treated as timed out. ## `maxChargeUsd` (type: `number`): Maximum estimated PPE charge allowed for the run before the actor stops gracefully. ## `searchResultHtmlByQuery` (type: `object`): Optional query-to-HTML map for deterministic search result testing without remote requests. ## Actor input object example ```json { "helpCenterBaseUrl": "https://support.zendesk.com/hc/en-us", "searchUrlTemplate": "https://support.zendesk.com/hc/en-us/search?query={query}", "queries": [ "getting started" ], "expectedResults": { "getting started": [ "https://support.zendesk.com/hc/en-us/articles/4408884056346-Introduction-Getting-started-with-Zendesk-Support" ] }, "expectedKeywords": { "getting started": [ "getting", "started" ] }, "resultSelectors": {}, "locale": "en-us", "maxResultsPerQuery": 5, "requestDelayMs": 0, "includeSnippets": true, "failOnMissingExpected": false, "timeoutMs": 15000, "maxChargeUsd": 1, "searchResultHtmlByQuery": { "getting started": "Introduction: Getting started with Zendesk Support

Zendesk Support getting-started tutorial.

", "knowledge base": "Creating articles in the knowledge base

Create and manage public knowledge base articles.

", "system requirements": "Zendesk system requirements

Supported operating systems and browsers.

", "help center": "Getting started with your help center

Prepare and activate a public help center.

", "security": "Zendesk system requirements

Review supported platforms before configuring security controls.

" } } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("junipr/kb-search-query-tester").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("junipr/kb-search-query-tester").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).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/kb-search-query-tester --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=junipr/kb-search-query-tester", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification Download the OpenAPI definition: https://api.apify.com/v2/actors/0k7dOCnB6D8vTKafu/builds/OlFgGPBRqiWHiPtgg/openapi.json