business_knowledge

Surfaces topics the support AI couldn't answer from the knowledge base.

Two list shapes controlled by the ticket_id query param:

  • per-ticket (?ticket_id=<uuid>): individual gap rows for that ticket.
  • aggregated (no ticket_id): gaps grouped by normalized topic with counts, for the Business knowledge suggestions panel.
get/api/projects/{project_id}/business_knowledge/gap_suggestions/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/business_knowledge/gap_suggestions/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

ticket_idstring uuid

When provided, returns per-ticket gap rows instead of aggregated view. Requires ticket:read scope in addition to business_knowledge:read.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

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