# Help Center Article Inventory (`junipr/help-center-article-inventory`) Actor

Inventory public help-center articles, categories, metadata, canonical links, update signals, breadcrumbs, and support-content coverage indicators.

- **URL**: https://apify.com/junipr/help-center-article-inventory.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 $4.90 / 1,000 help center page scanneds

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 Article Inventory

Inventory public help-center articles, categories, article metadata, canonical links, update signals, breadcrumbs, and support-content coverage indicators.

### What It Does

This actor scans authorized public help-center URLs or supplied public HTML snapshots and produces source-backed article inventory rows. It extracts article title, canonical URL, category, subcategory, breadcrumb path, visible update signals, word count, searchable-answer evidence, support intent, issue code, risk level, and recommended cleanup action.

### What It Does Not Do

- It does not bypass logins, paywalls, CAPTCHAs, access controls, or private APIs.
- It does not infer private article history, traffic, search rank, customer sentiment, or compliance status.
- It does not change source sites, private systems, or publication settings.

### Example Input

```json
{
  "startUrls": [
    "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues",
    "https://docs.github.com/en/get-started/start-your-journey/hello-world"
  ],
  "maxPages": 1,
  "maxDepth": 0,
  "includePatterns": [
    "/en/"
  ],
  "excludePatterns": [
    "/login",
    "/admin"
  ],
  "requestDelayMs": 250,
  "timeoutMs": 20000,
  "maxRecords": 10,
  "respectRobotsTxt": true,
  "redactQueryStrings": true,
  "maxChargeUsd": 10,
  "debug": false
}
```

### Example Output

```json
[
  {
    "actorSlug": "help-center-article-inventory",
    "runId": "schema-default-validation",
    "crawlTimestamp": "2026-07-11T00:56:45.836Z",
    "sourceUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "pageUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "status": "inventory-issue",
    "statusCode": 200,
    "evidence": "About two-factor authentication | category: Authentication | words: 740 | Authentication Secure your account with 2FA About 2FA About two-factor authentication Two-factor authentication (2FA) is an extra layer of security used when logging into websites ",
    "issueCode": "missing-update-signal",
    "riskLevel": "medium",
    "recommendation": "Add a visible reviewed or last-updated date so support teams can prioritize stale articles.",
    "articleTitle": "About two-factor authentication",
    "articleUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "category": "Authentication",
    "subcategory": "Secure your account with 2FA",
    "breadcrumbPath": "Authentication > Secure your account with 2FA > About 2FA",
    "lastUpdatedText": "",
    "canonicalUrl": "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "wordCount": 740,
    "hasSearchableAnswer": true,
    "supportIntent": "account_access"
  }
]
```

### Output Fields

- `actorSlug`
- `runId`
- `crawlTimestamp`
- `sourceUrl`
- `pageUrl`
- `status`
- `statusCode`
- `evidence`
- `issueCode`
- `riskLevel`
- `recommendation`
- `articleTitle`
- `articleUrl`
- `category`
- `subcategory`
- `breadcrumbPath`
- `lastUpdatedText`
- `canonicalUrl`
- `wordCount`
- `hasSearchableAnswer`
- `supportIntent`

### Pricing And Cost Controls

- Pricing model: Pay per event.
- Platform usage pass-through: OFF.
- Default max charge: $10.00.
- Events: `actor-start`, `help-center-page-scanned`, `article-record-extracted`, `inventory-issue-emitted`, and `audit-report-generated`.
- The runtime charges before paid dataset output and stops before output when the local max-charge guard is reached.

### Reports

The actor writes `SUMMARY.md`, `SUMMARY.json`, inventory CSV, findings CSV, issues-by-severity JSON, and blocked/no-result diagnostics CSV to key-value storage when the report event is charged.

### Limitations

Use public, authorized sources only. Supply source records for deterministic review runs or when a help center blocks unauthenticated crawling.

# Actor input Schema

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

Public help-center article, category, or index URLs to inventory. Use only authorized public pages.

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

Maximum number of public help-center pages or source records to scan.

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

Maximum same-site crawl depth for future live crawling. Local source records use depth 0.

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

Only scan 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`):

Remove query strings from output URLs unless 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.

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

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

## Actor input object example

```json
{
  "startUrls": [
    "https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication",
    "https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues",
    "https://docs.github.com/en/get-started/start-your-journey/hello-world"
  ],
  "maxPages": 1,
  "maxDepth": 0,
  "includePatterns": [
    "/en/"
  ],
  "excludePatterns": [
    "/login",
    "/admin"
  ],
  "requestDelayMs": 250,
  "timeoutMs": 20000,
  "maxRecords": 10,
  "respectRobotsTxt": true,
  "redactQueryStrings": true,
  "maxChargeUsd": 10,
  "debug": false
}
```

# Actor output Schema

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

No description

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

No description

## `inventory` (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-article-inventory").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-article-inventory").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-article-inventory --silent --output-dataset

```

## MCP server setup

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

```

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/XczVevixkfgpfgkvM/builds/FptnzdIbdSaFDAZVV/openapi.json