Recommendations - NeetoKB Docs

A recommendation is a group of articles NeetoKB suggests for a given page, used to surface contextual help. For fields and response details, see the API reference. Samples on this page show the --json envelope, which stays stable across terminals; the default pretty output picks columns to fit your terminal width. See Output formats.

List recommendations

This command returns the recommended articles for a page. Use this when you want to preview what your in-app help widget would show for a URL, or to build your own contextual help surface.

neetokb recommendations list
neetokb recommendations list --match-uri feedback

Flag	Type	Default	Description
`--match-uri`	`string`		Filter recommendations by URI
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)

--match-uri is the relative or full URL of the page you want suggestions for. Omit it to get the default recommendations.

Sample output (--json)

{
  "data": [
    {
      "title": "Feedback",
      "articles": [
        {
          "id": "a1b2c3d4-1111-2222-3333-444455556666",
          "title": "Collecting customer feedback",
          "category": {
            "id": "b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a",
            "name": "Getting Started"
          }
        }
      ]
    }
  ],
  "breadcrumbs": [
    { "label": "List articles", "command": "neetokb articles list" }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Each entry is a titled group holding the articles recommended for it. Pass an article id to neetokb articles show to read the full content.

​List recommendations

List recommendations