SEO Pro

https://github.com/statamic/seo-pro
Admin
SEO Pro is an all-in-one Statamic addon for site reporting, metadata management, Open Graph, Twitter...
Tokens:68,429
Snippets:566
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install SEO Pro with Composer

Source: https://github.com/statamic/seo-pro/blob/7.x/DOCUMENTATION.md

Install the SEO Pro addon via Composer.

```bash
composer require statamic/seo-pro
```

--------------------------------

### Statamic\SeoPro\Facades\Redirect

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/facades.md

Documentation for the Redirect facade, including all available methods and usage examples.

```APIDOC
## Facade: `Statamic\SeoPro\Facades\Redirect`

### Description
Laravel facade over the `RedirectRepository` interface. Provides the primary programmatic API for interacting with redirects from consumer code.

### Methods

#### `all()`
- **Signature**: `static function all()`
- **Returns**: `Illuminate\Support\Collection` of `Redirect`

#### `query()`
- **Signature**: `static function query()`
- **Returns**: `RedirectQueryBuilder`

#### `find($id)`
- **Signature**: `static function find($id)`
- **Parameters**: `$id` (mixed) - The redirect ID.
- **Returns**: `?Redirect` - Returns `null` when not found.

#### `make()`
- **Signature**: `static function make()`
- **Returns**: `Redirect` - A new instance.

#### `save(Redirect $redirect)`
- **Signature**: `static function save(Redirect $redirect)`
- **Parameters**: `$redirect` (Redirect) - The redirect to save.
- **Returns**: `void`

#### `delete(Redirect $redirect)`
- **Signature**: `static function delete(Redirect $redirect)`
- **Parameters**: `$redirect` (Redirect) - The redirect to delete.
- **Returns**: `void`

#### `blueprint()`
- **Signature**: `static function blueprint()`
- **Returns**: `Statamic\Fields\Blueprint`

### Example: Create multiple redirects
```php
use Statamic\SeoPro\Facades\Redirect;

foreach (['/old-a' => '/new-a', '/old-b' => '/new-b'] as $source => $destination) {
    Redirect::make()
        ->source($source)
        ->destination($destination)
        ->site('default')
        ->responseCode(301)
        ->enabled(true)
        ->save(); // Redirect::save() → RedirectCreated + RedirectSaved + error cleanup
}
```

### Example: Check existence before creating
```php
use Statamic\SeoPro\Facades\Redirect;

$existing = Redirect::find('about'); // id is a slug of the source

if (! $existing) {
    Redirect::make()->source('/about')->destination('/about-us')->save();
}
```
```

--------------------------------

### Error Query Example

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/error.md

Example of querying the most-hit 404 paths on a site.

```APIDOC
## Error Query Example

### Description
Query the most-hit 404 paths on a site using the Error facade.

### Code
```php
use Statamic\SeoPro\Facades\Error;

$worst = Error::query()
    ->where('site', 'default')
    ->orderBy('hits', 'desc')
    ->limit(10)
    ->get();

foreach ($worst as $error) {
    echo sprintf('%s × %d hits, last %s', $error->url(), $error->hits(), $error->lastHitAt());
}
```

```

--------------------------------

### Error Record and Cleanup Example

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/error.md

Example of manually recording an error and cleaning it up via redirect creation.

```APIDOC
## Error Record and Cleanup Example

### Description
Record an error manually and then clean it up once a redirect fixes it.

### Code
```php
use Statamic\SeoPro\Facades\Error;

$error = Error::make()
    ->url('/broken-link')
    ->site('default')
    ->hits(1)
    ->save();

// Later: creating a Redirect with source '/broken-link' auto-deletes this error,
// so your consumer code only needs the redirect creation:
$redirect = \Statamic\SeoPro\Facades\Redirect::make()
    ->site('default')
    ->source('/broken-link')
    ->destination('/fixed-link')
    ->responseCode(301)
    ->enabled(true)
    ->save(); // deletes matching errors, dispatches RedirectCreated/RedirectSaved
```

```

--------------------------------

### sites() method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/sitemap.md

Returns all Statamic sites whose absolute URL starts with request()->schemeAndHttpHost(), run through the 'sites' hook. Used to scope sitemap queries to the current host in multi-site installs.

```php
public function sites(): IlluminateCollection
```

--------------------------------

### get() method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Resolves the full meta dataset, hydrating the view cascade and computing many keys such as compiled_title, canonical_url, and robots.

```php
public function get()
```

--------------------------------

### GET /seo-pro/site-defaults/configure

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Configures site defaults. Requires the 'edit seo site defaults' permission. Returns a list of sites with origin info. Returns 404 if not multi-site.

```APIDOC
## GET /seo-pro/site-defaults/configure

### Description
Configures site defaults. Requires the 'edit seo site defaults' permission. Returns a list of sites with origin info. Returns 404 if not multi-site.

### Method
GET

### Endpoint
/seo-pro/site-defaults/configure

### Authentication
`edit seo site defaults`

### Response
#### Success Response (200)
- **data** (array) - List of sites with `name`, `handle`, and `origin`

#### Error Response (404)
- **message** (string) - Not multi-site

#### Response Example
{
  "data": [
    {
      "name": "English",
      "handle": "en",
      "origin": null
    }
  ]
}
```

--------------------------------

### Typical production config for config/statamic/seo-pro.php

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/configuration.md

Example configuration for the SEO Pro addon, including asset container, sitemap, redirects, and reports settings. Combine with the environment switches shown below to enable automatic redirects and error tracking.

```php
// config/statamic/seo-pro.php
return [
    'assets' => [
        'container' => 'assets',
        'folder' => 'seo',
    ],

    'sitemap' => [
        'enabled' => true,
        'pagination' => [
            'enabled' => true,
            'limit' => 500,
        ],
    ],

    'redirects' => [
        'driver' => 'database',
        'track_hits' => false,
        'errors' => [
            'enabled' => true,
            'driver' => 'database',
            'max_errors' => 2500,
        ],
        'automatic_redirects' => [
            'enabled' => true,
            'collections' => ['pages', 'posts'],
        ],
    ],

    'reports' => [
        'keep_recent' => 10,
    ],
];
```

```env
SEO_PRO_AUTOMATIC_REDIRECTS=true
SEO_PRO_TRACK_ERRORS=true
```

--------------------------------

### GET {statamic.seo-pro.humans.url}

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Serves the humans.txt file. The URL is configurable via `statamic.seo-pro.humans.url`, defaulting to `/humans.txt`. It returns a plain text file rendered from the `seo-pro::humans` view.

```APIDOC
## GET {statamic.seo-pro.humans.url}

### Description
Serves the humans.txt file. The URL is configurable via `statamic.seo-pro.humans.url`, defaulting to `/humans.txt`. It returns a plain text file rendered from the `seo-pro::humans` view.

### Method
GET

### Endpoint
{statamic.seo-pro.humans.url} (default `/humans.txt`)

### Parameters
None

### Response
#### Success Response (200)
- **Content-Type**: text/plain
- **Body**: Rendered `seo-pro::humans` view with a `Cascade` composed of the site's raw site defaults

#### Error Response (404)
- Returned when `statamic.seo-pro.humans.enabled` is `false`

#### Response Example
(No example provided in source)

```

--------------------------------

### GET /seo-pro/redirects/create

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Returns the Inertia page for creating a new redirect, optionally pre-filling the source field via a query parameter.

```APIDOC
## GET /seo-pro/redirects/create

### Description
Returns the Inertia page for creating a new redirect, optionally pre-filling the source field via a query parameter.

### Method
GET

### Endpoint
/seo-pro/redirects/create

### Parameters
#### Query Parameters
- **source** (string) - Optional - Pre-fill value for the source field (used by the errors "create redirect" link).

### Response
#### Success Response (200)
- **component** (string) - Inertia component name (`Redirects/Create`).
- **props** (object) - Contains `blueprint`, `values`, `meta`, `submitUrl`.

#### Response Example
{
  "component": "Redirects/Create",
  "props": {
    "blueprint": {},
    "values": {},
    "meta": {},
    "submitUrl": "/seo-pro/redirects"
  }
}
```

--------------------------------

### GET /seo-pro/reports/create

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Creates a new pending report and redirects to its show page. Requires the 'view seo reports' permission.

```APIDOC
## GET /seo-pro/reports/create

### Description
Creates a new pending report and redirects to its show page. Requires the 'view seo reports' permission.

### Method
GET

### Endpoint
/seo-pro/reports/create

### Authentication
`view seo reports`

### Response
#### Success Response (302)
- **Location** (string) - Redirect to the newly created report's show page
```

--------------------------------

### get()

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Resolves the full meta dataset, hydrating the view cascade, applying fallbacks, and computing additional keys like compiled_title, canonical_url, and robots.

```APIDOC
## get()

### Description
Resolves the full meta dataset. Hydrates the view cascade, applies fallbacks for home entry and 404 handling, parses values, and merges computed keys.

### Method
`get()`

### Returns
`array` — The full meta array with all parsed input keys plus computed keys.

### Computed Keys

| Key | Meaning |
|---|---|
| `compiled_title` | Title combined with site name/separator/position (or pagination page suffix) |
| `og_type` | Fallback `'website'` when unset |
| `og_title` | `og_title`, else `title`, else `compiled_title` |
| `canonical_url` | `URL::tidy(trim(explicitUrl ?? canonical_url))`; appended with paginator URL for pages > 1 |
| `prev_url` / `next_url` | Paginator previous/next absolute URLs (null without paginator or when pagination disabled) |
| `home_url` | `Site::current()?->absoluteUrl()` or absolute `/` |
| `humans_txt` | Absolute URL to humans.txt when enabled |
| `site` | `$model->site()` or default site |
| `is_default_site` | bool |
| `alternate_locales` | Array of `['site', 'is_default_site', 'url', 'hreflang']` per published localization |
| `current_hreflang` | `xx-XX` formatted hreflang of current locale |
| `last_modified` | `$model->lastModified()` or null |
| `twitter_card` | `config('statamic.seo-pro.twitter.card')` |
| `twitter_title` / `twitter_description` | Fall back to `title` / `description` |
| `robots` | Array of robot directives |
| `robots_indexing` | `'noindex'` when `robots` contains `noindex`, else `'index'` |
| `json_ld` | Collection of JSON-encoded schema.org snippets |

### Behavior Summary
1. Hydrates the view cascade (`app(ViewCascade::class)`).
2. If no `$current` was set, falls back to the home entry (`Entry::findByUri('/')`) with `request()->url()` as the explicit URL.
3. In sitemap mode returns `getForSitemap()` instead.
4. If `response_code` data is `404` sets `title` to `'404 Page Not Found'`; if `>= 400` forces `robots_indexing` to `'noindex'`.
5. Parses every value (Antlers templates, `@seo:` references with fallback to section/site defaults, per-key `parse*Field` methods).
6. Merges computed keys into the returned array.
```

--------------------------------

### Basic usage: supplying all three layers explicitly

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Use this snippet to create a Cascade instance with site defaults, section defaults, and entry-specific data. It retrieves the meta array and outputs the compiled title and robots. The example assumes $entry is a Statamic entry being rendered.

```php
use Statamic\SeoPro\Cascade;
use Statamic\SeoPro\GetsSectionDefaults;
use Statamic\SeoPro\SiteDefaults\SiteDefaults;

$current = $entry; // Statamic entry being rendered

$meta = (new Cascade)
    ->withSiteDefaults(SiteDefaults::in($current->locale())->all())
    ->withSectionDefaults((new class { use GetsSectionDefaults; })->getSectionDefaults($current))
    ->with($current->value('seo', []))
    ->withCurrent($current)
    ->get();

echo $meta['compiled_title'];
echo implode(', ', $meta['robots']);
```

--------------------------------

### Bind custom redirect repository

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/repositories.md

Custom driver binding example. Re-register the Statamic repository to replace the whole repository, e.g., in a service provider. Note that alternative drivers need to keep their own storage because the Stache store registration is skipped when the driver is 'database'.

```php
use Statamic\SeoPro\Redirects\RedirectRepository;

Statamic::repository(RedirectRepository::class, MyCustomRedirectRepository::class);
```

--------------------------------

### GET {statamic.seo-pro.sitemap.pagination.url}

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Serves a paginated sitemap page. The URL is configurable via `statamic.seo-pro.sitemap.pagination.url`, defaulting to `/sitemap_{page}.xml`. This route is named `statamic.seo-pro.sitemap.page.show` and is used in `paginatedSitemaps()`.

```APIDOC
## GET {statamic.seo-pro.sitemap.pagination.url}

### Description
Serves a paginated sitemap page. The URL is configurable via `statamic.seo-pro.sitemap.pagination.url`, defaulting to `/sitemap_{page}.xml`. This route is named `statamic.seo-pro.sitemap.page.show` and is used in `paginatedSitemaps()`.

### Method
GET

### Endpoint
{statamic.seo-pro.sitemap.pagination.url} (default `/sitemap_{page}.xml`)

### Parameters
#### Path Parameters
- **page** (integer) - Required - The page number from the URL.

### Response
#### Success Response (200)
- **Content-Type**: text/xml
- **Body**: XML `<urlset>` of `Sitemap::paginatedPages($page)`

#### Error Response (404)
- Returned when sitemap is disabled, pagination is disabled, `{page}` is not an integer, or the page has no items.

#### Response Example
(No example provided in source)

```

--------------------------------

### GET {statamic.seo-pro.sitemap.url}

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Generates the main sitemap XML. The URL is configurable via the `statamic.seo-pro.sitemap.url` setting, defaulting to `/sitemap.xml`. It returns an XML sitemap or sitemap index depending on pagination settings.

```APIDOC
## GET {statamic.seo-pro.sitemap.url}

### Description
Generates the main sitemap XML. The URL is configurable via the `statamic.seo-pro.sitemap.url` setting, defaulting to `/sitemap.xml`. It returns an XML sitemap or sitemap index depending on pagination settings.

### Method
GET

### Endpoint
{statamic.seo-pro.sitemap.url} (default `/sitemap.xml`)

### Parameters
#### Query Parameters
- None

### Response
#### Success Response (200)
- **Content-Type**: text/xml
- **Body**: 
  - Without pagination: XML `<urlset>` of `Sitemap::pages()` rendered by `seo-pro::sitemap`
  - With pagination: XML sitemap index of URLs from `Sitemap::paginatedSitemaps()` rendered by `seo-pro::sitemap_index`

#### Error Response (404)
- Returned when `sitemap.enabled` is `false`

#### Response Example
(No example provided in source)

```

--------------------------------

### GET /sitemap.xsl

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Serves the static XSL stylesheet used to style sitemap XML files. This is a public route that returns the sitemap.xsl file with a content type of text/xsl.

```APIDOC
## GET /sitemap.xsl

### Description
Serves the static XSL stylesheet used to style sitemap XML files. This is a public route that returns the sitemap.xsl file with a content type of text/xsl.

### Method
GET

### Endpoint
/sitemap.xsl

### Parameters
None

### Response
#### Success Response (200)
- **Content-Type**: text/xsl
- **Body**: Static file content from `resources/views/generated/sitemap.xsl`

#### Response Example
(No example provided in source)

```

--------------------------------

### Uninstall SEO Pro with Composer

Source: https://github.com/statamic/seo-pro/blob/7.x/DOCUMENTATION.md

Run this command to uninstall the SEO Pro package. After removal, manually remove the 'seo' field from any blueprints that were saved while the package was installed.

```bash
composer remove statamic/seo-pro
```

--------------------------------

### Read augmented defaults for a locale

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/site-defaults.md

Shows how to retrieve localized site defaults and access augmented or raw values. Use SiteDefaults::in('default') to get a LocalizedSiteDefaults instance, then call augmented() for resolved values or all() for raw values including @seo: references.

```php
use Statamic\SeoPro\SiteDefaults\SiteDefaults;
use Statamic\SeoPro\SiteDefaults\LocalizedSiteDefaults;

$localized = SiteDefaults::in('default'); // ?LocalizedSiteDefaults

if ($localized) {
    $augmented = $localized->augmented();     // array of resolved values
    $raw = $localized->all();                 // raw values incl. @seo: refs / antlers
}
```

--------------------------------

### RedirectQueryBuilder interface

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/repositories.md

Empty marker interface for redirect query builders. Concrete builders extend a Statamic query builder, providing the full query-builder API (where, whereIn, whereNull, orderBy, limit, offset, paginate, get, first, count, chunk, lazy, etc.). The Stache driver uses where('source', 'LIKE', '%*%') for wildcard redirects and LIKE matching for searches.

```php
interface RedirectQueryBuilder
{
    //
}
```

--------------------------------

### bootAddon() - Main boot chain

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/service-provider.md

The main boot chain for the addon; every step returns $this (fluent).

```php
public function bootAddon()
{
    $this
        ->bootAddonConfig()
        ->bootAddonViews()
        ->bootAddonBladeDirective()
        ->bootAddonPermissions()
        ->bootAddonNav()
        ->bootAddonSubscriber()
        ->bootAddonGlidePresets()
        ->bootRedirects()
        ->bootRouteBindings()
        ->bootGit()
        ->bootAddonScheduledCommands()
        ->bootAddonGraphQL()
        ->bootMultisiteCommandHook();
}
```

--------------------------------

### Explicit URL override and defensive reads

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Use this snippet to override the canonical URL and read the resulting data defensively. Note that calling value() triggers a full get() per call, so cache the result in loops. The example checks for 'noindex' in robots and iterates over alternate locales.

```php
$cascade = (new Cascade)->withExplicitUrl('https://example.com/custom-canonical');

$data = $cascade->get();

if (in_array('noindex', $data['robots'])) {
    // skip indexing
}

foreach ($data['alternate_locales'] as $locale) {
    echo $locale['hreflang'].' -> '.$locale['url'];
}
```

--------------------------------

### Select redirect driver in ServiceProvider::bootRedirects()

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/repositories.md

Chosen at boot in ServiceProvider::bootRedirects(). Registers Stache repositories by default, and switches to Eloquent repositories when the corresponding config driver is 'database', also excluding the Stache stores.

```php
Statamic::repository(ErrorRepository::class, Redirects\Stache\ErrorRepository::class);
Statamic::repository(RedirectRepository::class, Redirects\Stache\RedirectRepository::class);

if (config('statamic.seo-pro.redirects.driver') === 'database') {
    $this->app['stache']->exclude('seo_pro_redirects');
    Statamic::repository(RedirectRepository::class, Redirects\Eloquent\RedirectRepository::class);
}

if (config('statamic.seo-pro.redirects.errors.driver') === 'database') {
    $this->app['stache']->exclude('seo_pro_errors');
    Statamic::repository(ErrorRepository::class, Redirects\Eloquent\ErrorRepository::class);
}
```

--------------------------------

### buildPath implementation

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/redirect.md

Constructs the path using the Stache store directory, appending site and ID for multi-site, or just ID for single-site.

```php
$directory = rtrim(Stache::store('seo_pro_redirects')->directory(), '/');

if (Site::multiEnabled()) {
    return $directory.'/'.$this->site().'/'.$this->id().'.yaml';
}

return $directory.'/'.$this->id().'.yaml';
```

--------------------------------

### Statamic\SeoPro\Facades\Error

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/facades.md

Documentation for the Error facade, including all available methods and usage examples.

```APIDOC
## Facade: `Statamic\SeoPro\Facades\Error`

### Description
Laravel facade over the `ErrorRepository` interface. Provides the primary programmatic API for interacting with 404 errors from consumer code.

### Methods

#### `all()`
- **Signature**: `static function all()`
- **Returns**: `Illuminate\Support\Collection` of `Error`

#### `query()`
- **Signature**: `static function query()`
- **Returns**: `ErrorQueryBuilder`

#### `find($id)`
- **Signature**: `static function find($id)`
- **Parameters**: `$id` (mixed) - The error ID.
- **Returns**: `?Error`

#### `make()`
- **Signature**: `static function make()`
- **Returns**: `Error` - A new instance.

#### `save(Error $error)`
- **Signature**: `static function save(Error $error)`
- **Parameters**: `$error` (Error) - The error to save.
- **Returns**: `void`

#### `delete(Error $error)`
- **Signature**: `static function delete(Error $error)`
- **Parameters**: `$error` (Error) - The error to delete.
- **Returns**: `void`

#### `blueprint()`
- **Signature**: `static function blueprint()`
- **Returns**: `Statamic\Fields\Blueprint`

### Example: Bulk delete with the facade
```php
use Statamic\SeoPro\Facades\Error;

Error::query()
    ->where('site', 'default')
    ->where('last_hit_at', '<', now()->subDays(90))
    ->get()
    ->each(fn ($error) => $error->delete()); // Error::delete() dispatches ErrorDeleted
```
```

--------------------------------

### GET /seo-pro/redirects/export

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Exports redirects to a CSV file, scoped to authorized sites.

```APIDOC
## GET /seo-pro/redirects/export

### Description
Exports redirects to a CSV file, scoped to authorized sites.

### Method
GET

### Endpoint
/seo-pro/redirects/export

### Response
#### Success Response (200)
- **Content-Type** (string) - `text/csv`
- **Content-Disposition** (string) - `attachment; filename=redirects.csv`
- **Body** (string) - CSV content with columns: `source, destination, response_code, enabled, description`.

#### Response Example
source,destination,response_code,enabled,description
/old-path,/new-path,301,true,Example redirect

```

--------------------------------

### GET /seo-pro/redirects/{seo_pro_redirect}/edit

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Returns the Inertia page for editing a redirect. Read-only when the user lacks edit permission.

```APIDOC
## GET /seo-pro/redirects/{seo_pro_redirect}/edit

### Description
Returns the Inertia page for editing a redirect. Read-only when the user lacks edit permission.

### Method
GET

### Endpoint
/seo-pro/redirects/{seo_pro_redirect}/edit

### Parameters
#### Path Parameters
- **seo_pro_redirect** (string) - Required - The redirect ID.

### Response
#### Success Response (200)
- **component** (string) - Inertia component name (`Redirects/Edit`).
- **props** (object) - Contains redirect data, blueprint, values, meta, submitUrl.

#### Response Example
{
  "component": "Redirects/Edit",
  "props": {
    "redirect": {
      "id": "redirect-id",
      "source": "/old-path",
      "destination": "/new-path"
    },
    "blueprint": {},
    "values": {},
    "meta": {},
    "submitUrl": "/seo-pro/redirects/redirect-id"
  }
}
```

--------------------------------

### Error::site()

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/error.md

Fluent getter/setter for the site handle. Falls back to default site when unset.

```APIDOC
## Error::site()

### Description
Fluent getter/setter for the site handle. Getter falls back to `Site::default()->handle()` when unset.

### Method
Fluent accessor

### Signature
```php
public function site($site = null)
```

### Parameters
- `$site` (mixed) - Optional - The site handle to set. If omitted, acts as a getter.

### Returns
- When setting: `$this` (fluent)
- When getting: The current site handle or the default site handle if unset.

```

--------------------------------

### bootRouteBindings() - Route bindings for error and redirect

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/service-provider.md

Registers Statamic route bindings for 'error' and 'redirect'. Front-end bindings only resolve when statamic.routes.bindings is true; CP routes always resolve.

```php
Route::bind('error', function ($id, $route = null) {
    if (! $route || (! $this->isCpRoute($route) && ! $this->isFrontendBindingEnabled())) {
        return $id;
    }

    $field = $route->bindingFieldFor('error') ?? 'id';

    return $field == 'id'
        ? Facades\Error::find($id)
        : Facades\Error::query()->where($field, $id)->first();
});
```

```php
Route::bind('redirect', /* same shape with Facades\Redirect */);
```

--------------------------------

### GET /seo-pro/redirects

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists redirects with optional filtering, sorting, and pagination. Returns a JSON collection of redirects or an Inertia page for the redirect index.

```APIDOC
## GET /seo-pro/redirects

### Description
Lists redirects with optional filtering, sorting, and pagination. Returns a JSON collection of redirects or an Inertia page for the redirect index.

### Method
GET

### Endpoint
/seo-pro/redirects

### Parameters
#### Query Parameters
- **filters** (object) - Optional - Filter criteria for the redirect list.
- **sort** (string) - Optional - Sort field and direction (default `source desc`).
- **order** (string) - Optional - Sort order (asc/desc).
- **search** (string) - Optional - Search term for source/destination (LIKE match).
- **perPage** (integer) - Optional - Number of items per page.
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **data** (array) - List of redirects (each with `id`, `status`, column values, `edit_url`, `editable`).
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "data": [
    {
      "id": "redirect-id",
      "status": "active",
      "source": "/old-path",
      "destination": "/new-path",
      "edit_url": "/seo-pro/redirects/redirect-id/edit",
      "editable": true
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 1
  }
}
```

--------------------------------

### Generate a Report On-Demand

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/reporting.md

Demonstrates creating a new report and choosing between synchronous generation or queuing it via an artisan command.

```php
use Statamic\SeoPro\Reporting\Report;

$report = Report::create()->save();   // new id, saved as 'pending'

// Option A: synchronous (blocking for large sites):
$report->generate();

// Option B: queue it via the artisan command:
$report->queueGenerate();

echo $report->id() . ' ' . $report->status(); // 'generating' once queued
```

--------------------------------

### GET /seo-pro/section-defaults

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists all SEO section defaults. Requires 'edit seo section defaults' permission. Returns an Inertia page for rendering the listing.

```APIDOC
## GET /seo-pro/section-defaults

### Description
Lists all SEO section defaults.

### Method
GET

### Endpoint
/seo-pro/section-defaults

### Parameters
None

### Response
#### Success Response (200)
- **Inertia** (object) - Inertia `SectionDefaults/Index` page

#### Response Example
(No explicit example provided)
```

--------------------------------

### GET /seo-pro/site-defaults/edit

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Edits site defaults. Requires the 'edit seo site defaults' permission. Returns an Inertia page with site defaults data.

```APIDOC
## GET /seo-pro/site-defaults/edit

### Description
Edits site defaults. Requires the 'edit seo site defaults' permission. Returns an Inertia page with site defaults data.

### Method
GET

### Endpoint
/seo-pro/site-defaults/edit

### Authentication
`edit seo site defaults`

### Parameters
#### Query Parameters
- **site** (string) - Optional - Site handle (multi-site only)

### Response
#### Success Response (200)
- **blueprint** (object) - The blueprint definition
- **initialValues** (object) - Initial field values
- **initialMeta** (object) - Initial field metadata
- **initialLocalizations** (array) - Localization data
- **initialHasOrigin** (boolean) - Whether the site has an origin
- **initialOriginValues** (object) - Origin values

#### Response Example
{
  "blueprint": {},
  "initialValues": {},
  "initialMeta": {},
  "initialLocalizations": [],
  "initialHasOrigin": false,
  "initialOriginValues": {}
}
```

--------------------------------

### create() static method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/reporting.md

Signature for the static create method that creates a new report instance, clears caches, and sets the id.

```php
public static function create($id = null)
```

--------------------------------

### GET /seo-pro/reports/{seo_pro_report}/pages

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists pages for a specific report. Requires the 'view seo reports' permission. Supports sorting, filtering, and pagination.

```APIDOC
## GET /seo-pro/reports/{seo_pro_report}/pages

### Description
Lists pages for a specific report. Requires the 'view seo reports' permission. Supports sorting, filtering, and pagination.

### Method
GET

### Endpoint
/seo-pro/reports/{seo_pro_report}/pages

### Authentication
`view seo reports`

### Parameters
#### Path Parameters
- **seo_pro_report** (string) - Required - The report ID

#### Query Parameters
- **sort** (string) - Optional - Sort field (default: `status`)
- **order** (string) - Optional - Sort order (`asc`/`desc`)
- **rule** (string) - Optional - Filter by rule handle
- **page** (integer) - Optional - Page number
- **perPage** (integer) - Optional - Items per page (default: `statamic.cp.pagination_size`)

### Response
#### Success Response (200)
- **data** (array) - Page resource collection
- **meta** (object) - Pagination and column metadata

#### Error Response (404)
- **message** (string) - Report not found

#### Response Example
{
  "data": [],
  "meta": {}
}
```

--------------------------------

### GET /seo-pro/reports

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists SEO reports. Requires the 'view seo reports' permission. Supports pagination and returns a collection of reports with meta columns.

```APIDOC
## GET /seo-pro/reports

### Description
Lists SEO reports. Requires the 'view seo reports' permission. Supports pagination and returns a collection of reports with meta columns.

### Method
GET

### Endpoint
/seo-pro/reports

### Authentication
`view seo reports`

### Parameters
#### Query Parameters
- **perPage** (integer) - Optional - Number of items per page
- **page** (integer) - Optional - Page number

### Response
#### Success Response (200)
- **data** (array) - Collection of reports (ReportResource)
- **meta** (object) - Pagination and column metadata

#### Response Example
{
  "data": [],
  "meta": {}
}
```

--------------------------------

### GET /seo-pro

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Displays the SEO dashboard. Requires any of the four SEO capability groups for navigation membership. Returns an Inertia page with view permissions.

```APIDOC
## GET /seo-pro

### Description
Displays the SEO dashboard. Requires any of the four SEO capability groups for navigation membership. Returns an Inertia page with view permissions.

### Method
GET

### Endpoint
/seo-pro

### Authentication
Any of the four SEO capability groups (nav membership)

### Response
#### Success Response (200)
- **canViewReports** (boolean) - Whether the user can view reports
- **canViewRedirects** (boolean) - Whether the user can view redirects
- **canEditSiteDefaults** (boolean) - Whether the user can edit site defaults
- **canEditSectionDefaults** (boolean) - Whether the user can edit section defaults

#### Response Example
{
  "canViewReports": true,
  "canViewRedirects": true,
  "canEditSiteDefaults": true,
  "canEditSectionDefaults": true
}
```

--------------------------------

### Configure database redirect storage

Source: https://github.com/statamic/seo-pro/blob/7.x/DOCUMENTATION.md

Store redirects in the database by setting the driver to 'database'. After changing this, run 'php please seo-pro:database-redirects' to publish the migration and import existing redirects.

```php
// config/statamic/seo-pro.php

'redirects' => [
    'driver' => 'database',
],
```

--------------------------------

### GET /seo-pro/errors

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists 404 errors with filtering, sorting, and search capabilities. Requires 'view seo redirects' permission. Returns JSON or Inertia page.

```APIDOC
## GET /seo-pro/errors

### Description
Lists 404 errors with filtering, sorting, and search capabilities.

### Method
GET

### Endpoint
/seo-pro/errors

### Parameters
#### Query Parameters
- **filters** (object) - Optional - JSON object of filters.
- **sort** (string) - Optional - Sort field and direction (default `last_hit_at desc`).
- **order** (string) - Optional - Sort order (asc/desc).
- **search** (string) - Optional - Search term for URL LIKE.
- **perPage** (integer) - Optional - Number of items per page.
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **JSON** (object) - `Errors` resource collection. Items are `ListedError` arrays containing `id`, column values, and `create_redirect_url`.
- **HTML** (object) - Inertia `Errors/Index` page.

#### Response Example
(No explicit example provided)
```

--------------------------------

### Publish SEO Pro Config

Source: https://github.com/statamic/seo-pro/blob/7.x/DOCUMENTATION.md

Publishes the SEO Pro configuration file to config/statamic/seo-pro.php for modification.

```bash
php artisan vendor:publish --tag="seo-pro-config"
```

--------------------------------

### GET /seo-pro/section-defaults/taxonomies/{seo_pro_taxonomy}/edit

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Displays the publish form for editing SEO defaults of a specific taxonomy. Requires 'edit seo section defaults' permission.

```APIDOC
## GET /seo-pro/section-defaults/taxonomies/{seo_pro_taxonomy}/edit

### Description
Displays the publish form for editing SEO defaults of a specific taxonomy.

### Method
GET

### Endpoint
/seo-pro/section-defaults/taxonomies/{seo_pro_taxonomy}/edit

### Parameters
#### Path Parameters
- **seo_pro_taxonomy** (string) - Required - The taxonomy handle.

### Response
#### Success Response (200)
- **Publish form** (object) - Publish form for taxonomy SEO defaults (seeded from `inject.seo`).

#### Response Example
(No explicit example provided)
```

--------------------------------

### POST /seo-pro/redirects/actions/list

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Lists available bulk actions for the selected redirects.

```APIDOC
## POST /seo-pro/redirects/actions/list

### Description
Lists available bulk actions for the selected redirects.

### Method
POST

### Endpoint
/seo-pro/redirects/actions/list

### Parameters
#### Request Body
- **ids** (array of strings) - Required - List of redirect IDs to check actions for.

### Request Example
{
  "ids": ["redirect-id-1", "redirect-id-2"]
}

### Response
#### Success Response (200)
- **data** (array) - List of available actions (e.g., `DeleteRedirect`).

#### Response Example
{
  "data": [
    "DeleteRedirect"
  ]
}
```

--------------------------------

### Constructor

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Initializes the Cascade instance with an empty data collection and a NullModel.

```APIDOC
## Constructor

### Description
Initialises the Cascade instance with an empty data collection and a NullModel.

### Method
`__construct`

### Parameters
None.

### Returns
No return value.
```

--------------------------------

### GET /seo-pro/section-defaults/collections/{seo_pro_collection}/edit

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Displays the publish form for editing SEO defaults of a specific collection. Requires 'edit seo section defaults' permission.

```APIDOC
## GET /seo-pro/section-defaults/collections/{seo_pro_collection}/edit

### Description
Displays the publish form for editing SEO defaults of a specific collection.

### Method
GET

### Endpoint
/seo-pro/section-defaults/collections/{seo_pro_collection}/edit

### Parameters
#### Path Parameters
- **seo_pro_collection** (string) - Required - The collection handle.

### Response
#### Success Response (200)
- **Publish form** (object) - Publish form for collection SEO defaults (seeded from `inject.seo`).

#### Response Example
(No explicit example provided)
```

--------------------------------

### GET /seo-pro/reports/{seo_pro_report}

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Shows a specific SEO report. Requires the 'view seo reports' permission. Returns report data and triggers generation if necessary.

```APIDOC
## GET /seo-pro/reports/{seo_pro_report}

### Description
Shows a specific SEO report. Requires the 'view seo reports' permission. Returns report data and triggers generation if necessary.

### Method
GET

### Endpoint
/seo-pro/reports/{seo_pro_report}

### Authentication
`view seo reports`

### Parameters
#### Path Parameters
- **seo_pro_report** (string) - Required - The report ID

### Response
#### Success Response (200)
- **data** (object) - The report data (see types.md)

#### Error Response (404)
- **message** (string) - Report not found

#### Response Example
{
  "data": {}
}
```

--------------------------------

### Create a redirect programmatically

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/redirect.md

Creates a redirect with site, source, destination, response code, and enabled status, then saves it. Saving also deletes matching 404 errors.

```php
use Statamic\SeoPro\Facades\Redirect;

$redirect = Redirect::make()
    ->site('default')
    ->source('/old-page')
    ->destination('entry::collections_pages::new-page') // or '/new-page'
    ->responseCode(301)
    ->enabled(true);

$redirect->save(); // also deletes matching 404 errors
```

--------------------------------

### homeUrl() method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Returns the absolute URL of the current site, or a fallback absolute path to '/' when no current site exists.

```php
public function homeUrl()
```

--------------------------------

### SiteDefaults::blueprint() method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/site-defaults.md

Returns the defaults blueprint built by SiteDefaults\Blueprint::get().

```php
public static function blueprint(): \Statamic\Fields\Blueprint
```

--------------------------------

### Query seo field on terms

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/graphql.md

Example GraphQL query to retrieve SEO data from terms, including slug, title, description, robots indexing, priority, and change frequency.

```graphql
{
    terms {
        slug
        seo {
            title
            description
            robots_indexing
            priority
            change_frequency
        }
    }
}
```

--------------------------------

### site method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/redirect.md

Getter/setter for the site handle. The getter falls back to Site::default()->handle() when unset.

```php
public function site($site = null)
```

--------------------------------

### Use wildcard URL matching utilities

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/redirects-runtime.md

Demonstrates the WildcardUrlMatcher methods: match() extracts captures from a URL pattern, resolveDestination() substitutes captures into a destination pattern, and wildcardCount() returns the number of wildcards in a pattern.

```php
use Statamic\SeoPro\Redirects\WildcardUrlMatcher;

$captures = WildcardUrlMatcher::match('/blog/*/posts/*', '/blog/2024/posts/hello'); // ['2024', 'hello']

echo WildcardUrlMatcher::resolveDestination('/articles/$1/entries/$2', $captures);
// /articles/2024/entries/hello

echo WildcardUrlMatcher::wildcardCount('/blog/*/posts/*'); // 2
```

--------------------------------

### ValidRedirectUrl validation rule class

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/commands-and-widgets.md

Implements the `ValidationRule` interface. Fails with the message 'seo-pro::validation.redirect_url' unless the value is empty or starts with `/`. Applied to the redirect `source` blueprint field.

```php
class ValidRedirectUrl implements ValidationRule
{
    public function validate(string $attribute, mixed $value, Closure $fail): void
}
```

--------------------------------

### Static and instance query methods signatures

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/reporting.md

Signatures for nextId, all, latest, latestGenerated, find, and fresh methods used for retrieving reports.

```php
public static function nextId()
public static function all()
public static function latest()
public static function latestGenerated()
public static function find($id)
public function fresh()
```

--------------------------------

### Blueprint class definition

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/site-defaults.md

Defines the Blueprint class with a static get() method returning a Statamic\Fields\Blueprint. The blueprint includes tabs for meta, json-ld, robots, opengraph, social, sitemap, and search fields.

```php
class Blueprint
{
    use HasAssetField;

    public static function get(): \Statamic\Fields\Blueprint
}
```

--------------------------------

### Query seo field on entries

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/graphql.md

Example GraphQL query to retrieve SEO data from entries, including compiled title, canonical URL, robots, Open Graph title, HTML, alternate locales, and JSON-LD.

```graphql
{
    entries {
        title
        seo {
            compiled_title
            canonical_url
            robots
            og_title
            html
            alternate_locales {
                site {
                    handle
                }
                url
            }
            json_ld
        }
    }
}
```

--------------------------------

### POST /seo-pro/preview

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/endpoints.md

Generates preview URLs for content with SEO metadata, including Open Graph and Twitter image URLs.

```APIDOC
## POST /seo-pro/preview

### Description
Generates preview URLs for content with SEO metadata, including Open Graph and Twitter image URLs.

### Method
POST

### Endpoint
/seo-pro/preview

### Parameters
#### Request Body
- **id** (string) - Required - Content reference (resolved via `Data::find`).
- **values** (object) - Required - Field values; `slug` is handled specially.
- **image** (string) - Optional - Asset ID for the preview image.

### Request Example
{
  "id": "pages.home",
  "values": {
    "title": "Home",
    "slug": "home"
  },
  "image": "assets/og-image.jpg"
}

### Response
#### Success Response (200)
- **url** (string) - Preview URL.
- **og_image_url** (string) - Open Graph image URL (transformed via Glide preset `seo_pro_og`).
- **twitter_image_url** (string) - Twitter image URL (transformed via Glide preset `seo_pro_twitter`).

#### Response Example
{
  "url": "https://example.com/preview/123",
  "og_image_url": "https://example.com/img/og-image.jpg",
  "twitter_image_url": "https://example.com/img/twitter-image.jpg"
}
```

--------------------------------

### withSiteDefaults($data)

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/cascade.md

Merges site defaults into the cascade and records them as the site-defaults layer for fallback resolution.

```APIDOC
## withSiteDefaults($data)

### Description
Merges `$data` into the cascade and records it as the site-defaults layer used for fallback resolution in `parse()`.

### Method
`withSiteDefaults`

### Parameters
- `$data` (array) - Required - Site defaults for the current site (typically `SiteDefaults::in($locale)->all()`).

### Returns
`$this` for chaining.
```

--------------------------------

### Widget configuration in config/statamic/cp.php

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/commands-and-widgets.md

Adds the SEO Pro and recent errors widgets to the control panel, with width and display options.

```php
'widgets' => [
    ['type' => 'seo_pro', 'width' => 50],
    ['type' => 'recent_errors', 'width' => 50, 'limit' => 5, 'show_table_header' => true],
],
```

--------------------------------

### path method signature

Source: https://github.com/statamic/seo-pro/blob/7.x/_autodocs/api-reference/redirect.md

Returns the on-disk Stache path for this redirect.

```php
public function path(): string
```
Tokens:
Raw