Seo (admin API)

Admin routes of the seo module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

GET /v1/admin/seo/analytics

Get Google Search Console analytics rollup

Parameters:

• range in query ("28d", "7d", "90d", optional).

Responses:

• 200: no description. Body: object.

GET /v1/admin/seo/coverage

Get per-engine sitemap coverage

Responses:

• 200: no description. Body: object.

GET /v1/admin/seo/health

Get SEO health check report

Responses:

• 200: no description.

POST /v1/admin/seo/health/recheck

Re-check live search engine submission health

Responses:

• 200: no description. Body: object.

GET /v1/admin/seo/quota

Get search engine submission quota readout

Responses:

• 200: no description. Body: object.

GET /v1/admin/seo/redirects

List SEO redirects

Parameters:

• isAutoGenerated in query (boolean, optional).
• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).
• search in query (string, optional).
• sortBy in query ("createdAt", "fromPath", "updatedAt", optional).
• sortOrder in query ("asc", "desc", optional).

Responses:

• 200: no description.

POST /v1/admin/seo/redirects

Create new SEO redirect

Request body: CreateRedirectAdminDto.

Responses:

• 201: no description.

DELETE /v1/admin/seo/redirects/{id}

Delete SEO redirect

Parameters:

• id in path (string, required).

Responses:

• 204: no description.

GET /v1/admin/seo/submissions

List search engine submission history

Parameters:

• accepted in query (boolean, optional).
• engine in query ("bing", "gsc", "indexnow", optional).
• from in query (string, optional).
• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).
• sortBy in query ("createdAt", optional).
• sortOrder in query ("asc", "desc", optional).
• targetType in query ("products", "sitemap", "url", optional).
• to in query (string, optional).
• trigger in query ("auto-regen", "cron", "manual", optional).

Responses:

• 200: no description.

POST /v1/admin/seo/submit

Submit URLs or sitemap to search engines for reindexing

Request body: SubmitSeoAdminDto.

Responses:

• 200: no description. Body: object.

GET /v1/admin/seo/url-inspection

Get Google index state for one URL

Parameters:

• locale in query ("ar", "en", "fr", optional).
• productId in query (string, optional).
• url in query (string, uri, optional).

Responses:

• 200: no description. Body: object.

Schemas

CreateRedirectAdminDto

• fromPath (string, required).
• toPath (string, required).
• type ("FOUND", "MOVED_PERMANENTLY", optional).

SubmitSeoAdminDto

• url (string, uri, optional).
• productIds (array of string, optional).
• sitemap (boolean, optional).
• engines (array of "bing", "gsc", "indexnow", optional).
• dryRun (boolean, optional).