signals

Edit a report's title or summary

Edit the human-facing title and/or summary (description) of a signal report, addressed by id. Both fields are optional — supply only the ones you want to change; at least one is required. Every other report field (status, weights, judgments) is managed by the signals pipeline and cannot be set here. Returns the full updated report.

patch/api/projects/{project_id}/signals/reports/{id}/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this signal report.

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

Request body

titlestring

New human-facing title for the report. Omit to leave the title unchanged.

summarystring

New summary (the report's description) explaining what the report is about. Omit to leave the summary unchanged.

Response

Report updated.

idstring uuid required
titlestring nullable required
summarystring nullable required
summary_leadstring required

The opening of summary as plain text on one line: the text before its first section heading, with chart links removed and other links reduced to their text. At most 450 characters.

status'potential' | 'candidate' | 'in_progress' | 'pending_input' | 'ready' | 'monitoring' | 'resolved' | 'failed' | 'deleted' | 'suppressed' required
  • potential - Potential
  • candidate - Candidate
  • in_progress - In Progress
  • pending_input - Pending Input
  • ready - Ready
  • monitoring - Monitoring
  • resolved - Resolved
  • failed - Failed
  • deleted - Deleted
  • suppressed - Suppressed
total_weightnumber double required
signal_countinteger required
signals_at_runinteger required
collapsed_note_countinteger required

How many scout notes this report received beyond the few its work log keeps as entries. 0 when nothing was dropped. These say the finding still holds, so the count is shown in place of the entries.

created_atstring date-time required
updated_atstring date-time required
artefact_countinteger required
suggested_promptsstring[] required

Follow-up prompts the report's author suggests sending about it (questions to ask, or next-step actions to request), in the order they were written. The inbox offers them above the Ask AI box; clicking one fills the box with it.

prioritystring nullable required

P0–P4 from the latest priority judgment artefact (when present).

actionabilitystring nullable required

Actionability choice from the latest actionability judgment artefact (when present).

already_addressedboolean nullable required

Whether the issue is already being handled — fixed in recent changes, or with a fix in flight (an open PR, a recently active branch, an assigned / in-progress issue or agent task) — from the actionability judgment artefact.

dismissal_reasonstring nullable required

Reason code from the latest dismissal artefact, set when the report was suppressed (when present).

dismissal_notestring nullable required

Free-form note captured alongside the dismissal reason (when present).

suppression_explanationstring nullable required

The judge's explanation when suppression_source is safety_judge or not_actionable. Null otherwise, or when the judge gave none.

repo_slugstring nullable required

organization/repository the report's work targets, from the latest repo-selection artefact (when present). Lets list cards show repository context without a per-card fetch.

is_suggested_reviewerboolean required
source_productsstring[] required

Distinct source products contributing signals to this report (from ClickHouse).

scout_namestring nullable required

skill_name slug of the scout that authored this report, when scout-authored (from ClickHouse); null otherwise.

implementation_pr_urlstring nullable required

Pull request attached to this report's claim, if available.

implementation_pr_mergedboolean required

Whether that implementation PR is merged, per the GitHub webhook. False when there is no PR or it hasn't merged. Report status doesn't imply this: a resolved report may have been resolved directly, without a merged PR.

tracker_issue_urlstring nullable required

Link to the issue self-driving opened in the team's tracker for this report's pull request. Null when the team tracks no issues, or the issue could not be opened.

tracker_issue_referencestring nullable required

How that tracker issue reads in its provider, for example '#12' or 'ENG-123'. Null when there is no tracker issue.

tracker_issue_errorstring nullable required

Why the tracker issue could not be opened, for a team that wants one. Null when the issue exists or the team tracks no issues.

work_state'unclaimed' | 'working' | 'in_review' | 'done' required
channel_idstring uuid nullable required

The space (task channel) this report is assigned to, or null when unassigned. The general view lists every report regardless of this value.

Changes

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