signals

List scout notes

Return the steering notes left for this project's scouts, newest first. Pass skill_name to get the notes addressed to one scout (or one pipeline audience, e.g. pipeline:report-research) plus the general (blank-target) fleet-wide notes — the shape a scout run reads at cold start. Omit skill_name to browse every note. Expired notes are excluded unless include_expired=true. date_from / date_to are a half-open window on created_at (>= date_from, < date_to); pass date_to (the created_at of the oldest note seen) to walk past the cap. Pass text to keep only the notes whose content contains it, case-insensitively. Results capped at 500.

get/api/projects/{project_id}/signals/scout/notes/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/signals/scout/notes/
  • Auth: one of:
    • HTTP bearer
    • 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

content_max_charsinteger

Truncate each note's content to the first N characters (a preview). Omit for the full body — use this on wide scans so stacked notes can't dominate your context.

date_fromstring date-time

ISO-8601 inclusive lower bound on created_at. Omit to skip the lower bound.

date_tostring date-time

ISO-8601 exclusive upper bound on created_at. Pass the created_at of the oldest note from the prior page to walk back past the result cap.

include_expiredboolean

Include notes whose expires_at has passed. Off by default so time-boxed steering retires itself.

include_generalboolean

Only meaningful with skill_name: when false, exclude the general fleet-wide notes and return the target's own notes only.

limitinteger

Max rows to return (default 20, hard cap 500).

skill_namestring

Return the notes addressed to this target plus the general (blank-target) notes for the whole fleet. Pass a configured scout's skill name or a pipeline audience (pipeline:report-research). Omit to browse every note on the project.

textstring

Return only the notes whose content contains this text, case-insensitively. Pass an entity (an error id, a flag key, a page path, an event name) to find the notes about it, including older ones the newest-first cap would hide.

Response

Matching notes newest-first.

idstring required

Note UUID. Pass to scout-notes-delete to retire the note.

skill_namestring required

Who the note is addressed to: a configured scout's skill name, a pipeline audience (pipeline:*, e.g. pipeline:report-research), or blank for a general note every scout sees.

contentstring required

The note's prose, read verbatim by the run that picks it up.

created_atstring nullable required

ISO-8601 creation timestamp.

expires_atstring nullable required

ISO-8601 expiry, or null for a note that stays active until deleted.

created_by_namestring nullable required

Display name of the user who left the note, or null when unavailable.

originstring required

Where the note came from. human for one left directly through this API. report_dismissal for one forwarded from the note someone typed when they dismissed, snoozed, or restored one or more inbox reports: one reviewer's verdict on the reports its content names, so weigh it as evidence about those reports rather than as fleet-level steering. report_discussion for the question someone asked when they opened a discussion on a report: context to weigh, neither a verdict on the report nor a directive. report_feedback for the note someone left when rating a report useful or not: one reader's rating of the named report, context to weigh rather than a directive. report_reviewer_correction for a suggested reviewer someone added or removed on a report: evidence about who owns that surface, and a prompt to revisit the routing memory it corrects, rather than a directive.

Changes

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