# Canonical/Hreflang Bulk QA (`checksmithcats/canonical-hreflang-bulk-qa`) Actor

Scan public static HTML for canonical and hreflang link-tag signals before launches, migrations, or template changes.

- **URL**: https://apify.com/checksmithcats/canonical-hreflang-bulk-qa.md
- **Developed by:** [Checksmith Cats](https://apify.com/checksmithcats) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 0 monthly users, 92.3% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.25 / report generated

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use 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

## Canonical/Hreflang Bulk QA

Scans public static HTML for canonical and hreflang link-tag signals.

This Actor is for teams that maintain multilingual, regional, ecommerce, editorial, or programmatic pages and need a quick evidence report before a release or migration. It reads public static HTML and reports machine-readable issues in the link tags that commonly carry canonicalization and localization intent.

### What it checks

- Input from `urls`, `sitemapUrl`, or public `csvUrl`
- Page fetch status for every sampled URL
- Optional sitemap URL-set monitor mode for repeated runs with `sitemapUrl`
- Missing, multiple, conflicting, relative, cross-host, query-string, fragment, and tracking-parameter canonical signals
- Missing hreflang as an informational signal for single-language pages
- Invalid hreflang values
- Relative or non-http hreflang hrefs
- Duplicate hreflang values
- Missing self-referencing hreflang URL
- Missing `x-default` when multiple hreflang alternates are declared
- Canonical/hreflang cluster alignment hints, without fetching every alternate URL

### Findings

Each finding includes:

- `severity`
- `confidence`
- `evidence`
- `caveat`
- source URL with query strings redacted
- Google documentation references where applicable

Primary finding IDs include:

- `canonical.missing`
- `canonical.multiple`
- `canonical.href_not_fully_qualified`
- `canonical.tracking_query`
- `canonical.cross_origin`
- `canonical.not_in_hreflang_cluster`
- `hreflang.missing`
- `hreflang.invalid_code`
- `hreflang.href_not_fully_qualified`
- `hreflang.duplicate_language`
- `hreflang.self_reference_missing`
- `hreflang.x_default_missing`
- `sitemap.url_added`
- `sitemap.url_removed`
- `sitemap.url_count_dropped`
- `sitemap.lastmod_stalled`

### Boundaries

This is an informational diagnostic tool for public pages. It does not validate overall SEO performance, reproduce Google Search Console, promise indexing, choose the canonical URL Google will select, promise localized serving, or improve rankings.

The scanner inspects static HTML only. It does not render JavaScript, sign in, solve CAPTCHA, fetch private pages, or verify reciprocal hreflang links on alternate pages.

Sitemap monitor mode compares the current public sitemap URL set with the latest compact baseline. It does not store sitemap response bodies and does not promise indexing, alert coverage, traffic, or platform outcomes.

### Billing note

Pay-per-event billing is based on reachable URLs only. Unreachable pages are reported as findings, but they are not counted as checked URLs.

### References

- Canonical URL methods: https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls
- URL canonicalization: https://developers.google.com/search/docs/crawling-indexing/canonicalization
- Localized versions and hreflang: https://developers.google.com/search/docs/specialty/international/localized-versions
- Managing multi-regional and multilingual sites: https://developers.google.com/search/docs/specialty/international/managing-multi-regional-sites

### Related tools

- Site Migration Redirect QA - Use when canonical findings are part of a URL migration or redirect map review.
- Social Card / Open Graph Bulk QA - Use when the same page set also needs share-preview metadata checks.
- Structured Data Bulk QA - Use when indexing signals and JSON-LD shape should be reviewed together.

# Actor input Schema

## `urls` (type: `array`):

Public page URLs to check.
## `sitemapUrl` (type: `string`):

Optional public sitemap URL containing pages to sample.
## `csvUrl` (type: `string`):

Optional public CSV URL with a URL column such as url, pageUrl, link, href, loc, or canonical.
## `sampleLimit` (type: `integer`):

Maximum number of extracted URLs to inspect.
## `sitemapMonitorMode` (type: `boolean`):

When sitemapUrl is provided, compare the current compact sitemap URL set with the latest saved baseline.
## `saveBaseline` (type: `boolean`):

Save the current compact sitemap snapshot as the latest baseline for the next monitor run.
## `stateStoreName` (type: `string`):

Key-value store name for sitemap monitor state.

## Actor input object example

```json
{
  "urls": [
    "https://example.com/en/product",
    "https://example.com/ja/product"
  ],
  "sampleLimit": 25,
  "sitemapMonitorMode": false,
  "saveBaseline": true,
  "stateStoreName": "canonical-sitemap-urlset-monitor-state"
}
````

# Actor output Schema

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

No description

## `report` (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 = {
    "urls": [
        "https://example.com/en/product",
        "https://example.com/ja/product"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("checksmithcats/canonical-hreflang-bulk-qa").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 = { "urls": [
        "https://example.com/en/product",
        "https://example.com/ja/product",
    ] }

# Run the Actor and wait for it to finish
run = client.actor("checksmithcats/canonical-hreflang-bulk-qa").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 '{
  "urls": [
    "https://example.com/en/product",
    "https://example.com/ja/product"
  ]
}' |
apify call checksmithcats/canonical-hreflang-bulk-qa --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=checksmithcats/canonical-hreflang-bulk-qa",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Canonical/Hreflang Bulk QA",
        "description": "Scan public static HTML for canonical and hreflang link-tag signals before launches, migrations, or template changes.",
        "version": "0.1",
        "x-build-id": "WjadNV00fy92my7E9"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/checksmithcats~canonical-hreflang-bulk-qa/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-checksmithcats-canonical-hreflang-bulk-qa",
                "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~canonical-hreflang-bulk-qa/runs": {
            "post": {
                "operationId": "runs-sync-checksmithcats-canonical-hreflang-bulk-qa",
                "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~canonical-hreflang-bulk-qa/run-sync": {
            "post": {
                "operationId": "run-sync-checksmithcats-canonical-hreflang-bulk-qa",
                "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": {
                    "urls": {
                        "title": "Page URLs",
                        "type": "array",
                        "description": "Public page URLs to check.",
                        "items": {
                            "type": "string",
                            "pattern": "^https?:\\/\\/.+"
                        }
                    },
                    "sitemapUrl": {
                        "title": "Sitemap URL",
                        "pattern": "^https?:\\/\\/.+",
                        "type": "string",
                        "description": "Optional public sitemap URL containing pages to sample."
                    },
                    "csvUrl": {
                        "title": "CSV URL",
                        "pattern": "^https?:\\/\\/.+",
                        "type": "string",
                        "description": "Optional public CSV URL with a URL column such as url, pageUrl, link, href, loc, or canonical."
                    },
                    "sampleLimit": {
                        "title": "Sample limit",
                        "minimum": 1,
                        "maximum": 500,
                        "type": "integer",
                        "description": "Maximum number of extracted URLs to inspect.",
                        "default": 25
                    },
                    "sitemapMonitorMode": {
                        "title": "Sitemap URL-set monitor mode",
                        "type": "boolean",
                        "description": "When sitemapUrl is provided, compare the current compact sitemap URL set with the latest saved baseline.",
                        "default": false
                    },
                    "saveBaseline": {
                        "title": "Save current sitemap snapshot",
                        "type": "boolean",
                        "description": "Save the current compact sitemap snapshot as the latest baseline for the next monitor run.",
                        "default": true
                    },
                    "stateStoreName": {
                        "title": "State store name",
                        "type": "string",
                        "description": "Key-value store name for sitemap monitor state.",
                        "default": "canonical-sitemap-urlset-monitor-state"
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
