signals

Dismiss a suggested scout

Hide one suggestion from this project's batch. Dismissal is remembered across refreshes by skill name, so the same suggestion is not shown again.

post/api/projects/{project_id}/signals/scout/suggestions/{id}/dismiss/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/signals/scout/suggestions/{id}/dismiss/
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this Signal scout suggestion set.

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/.

Response

The dismissed suggestion.

idstring required

Stable id of this suggestion within the batch; use it to dismiss.

kind'canonical' | 'custom' required
  • canonical - canonical
  • custom - custom
skill_namestring required

The scout's signals-scout-* skill name (existing for canonical, proposed for custom).

titlestring required

Short sentence-case title: what the scout watches.

why_herestring required

Project-specific evidence for this suggestion, in prose.

descriptionstring required

Custom only: the one-line description the scout would be created with.

draft_bodystring required

Custom only: the complete skill body the scout would be created with.

gapboolean required

True when nothing in the current fleet covers this.

confidence'low' | 'medium' | 'high' required
  • low - low
  • medium - medium
  • high - high

Changes

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