site-optimization

List Page Recommendations

Changed on

List the latest recommendations per page for a brand — each page's AI-visibility scores, the recommendations to improve it (in the opportunities field), and what it already does well (strengths).

Pass one or more path params (e.g. ?path=/about&path=/pricing) to scope to specific pages; omit them to page through every audited path. Paths are matched normalized (case-insensitive, trailing slash ignored). Each page returns only its most recent audit.

For a brand spanning several sites, each item carries its absolute url alongside path. Pass domain (e.g. us.example.com) to scope to one site, and/or path_prefix (e.g. /en-uk) for a locale or section under a host. Without them the list is brand-wide and two pages sharing a path across sites collapse onto one row.

get/{brand_id}/site-optimization/recommendations/by-page

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

Path parameters

brand_idinteger required

Query parameters

pathstring[] nullable

Restrict to these page paths. Repeat for multiple.

domainstring nullable

Scope to one site of the brand by host, e.g. us.example.com.

path_prefixstring nullable

Scope to a path prefix of the site, e.g. /en-uk for a locale section.

limitinteger

Maximum number of pages to return.

offsetinteger

Number of pages to skip (pagination).

Response

Successful Response

totalinteger required
offsetinteger
limitinteger nullable

Changes

    • info

      added the new optional query request parameter domain

    • info

      added the new optional query request parameter path_prefix

    • info

      added the required property // to the response with the status

    • info

      endpoint added