Routes

List a site's routes

Lists the site's routes (each maps a URL path to a content key and a layout), sorted by path, one page at a time. The default and maximum page is 1,000 routes, so most sites arrive in one response. Follow nextCursor until it is null, and treat partial: true as a window, not the whole set.

Two other row shapes are served from this same URL — ?view=pages (pages grouped by layout) and ?purpose=redirect (redirect rows with their issues) — and are not part of this contract.

get/api/v1/sites/{slug}/routes

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/routes
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Query parameters

limitinteger

Page size, 1–1,000. Defaults to 1,000; larger values are capped.

cursorstring

Opaque cursor from the previous page's nextCursor. Pass it back unchanged.

qstring

Only routes whose path, content key, layout or title contains this text (case-insensitive).

Response

One page of routes.

nextCursorstring nullable required

Pass as cursor for the next page. Null on the last page.

routesListTotalinteger nullable required

How many routes the site has (or how many match q). Null when the total is not known yet — never read it as zero.

partialboolean required

True when this page is a window over a large site rather than the whole set. Keep following nextCursor.

Example response

{
  "routes": [
    {
      "path": "/about",
      "contentKey": "about.html",
      "layout": "layouts/main.html",
      "title": "About us"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.