Client API: Help

The docs site's guides for a page of the dashboard, and a search over them. Needs no auth.

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/help/changelog

List the newest changes from the changelog on the docs site. No sign-in needed.

The changelog has a page for each month. Under each date, every change has a title and a paragraph that describes it. The answer lists those changes newest first, up to limit. Each has its date as YYYY-MM-DD, its title, its paragraph as plain text in summary, and its url: the change in the changelog on the docs site, which links the guide that covers it.

docs_url is the docs site's home page and changelog_url is the changelog's first page. The changes and their addresses are those of the storefront the request came through; on a storefront with no docs site, both are null and the list is empty.

Refuses with 422 when limit is below 1 or above 100.

Fields of a 200 response:

GET /api/v1/help/pages

List the guides for a page of the dashboard. No sign-in needed.

Send the path of the page the customer is on as route. The answer lists up to eight guides from the docs site, most specific first: the guides written for that page, then the guides for the pages above it. For a folder open in a server's file manager, that is the guides for the Files tab, then those for the servers list, then those for the dashboard.

On a resource's Overview, a path such as /dashboard/websites/example.com/overview, the tutorials that name the resource's list or a page under it come first, then the other guides in that order. A tutorial takes a customer from a new resource to a working result.

Each guide has its title, a one-sentence description, its url on the docs site, its type and the section of the docs it is in. docs_url is the docs site's home page. The guides and their addresses are those of the storefront the request came through; on a storefront with no docs site, docs_url is null and the list is empty.

Refuses with 422 when route is missing, does not start with /, or is longer than 512 characters.

Fields of a 200 response:

GET /api/v1/help/search

Search the guides on the docs site. No sign-in needed.

Answers with up to eight guides for the words in q, best match first, each in the same shape as GET /api/v1/help/pages gives. A guide matches when every word appears in it, and the last word also matches the start of a longer word, so the results can follow the customer's typing. A match in a title counts most. An empty q answers an empty list.

The API reference is not searched here: search_url opens the same search on the docs site, which includes it. The guides are those of the storefront the request came through.

Refuses with 422 when q is longer than 200 characters.

Fields of a 200 response: