provider signals POST
/api/projects/{project_id}/signals/reports/{id}/state/ @utdk/posthog
/api/projects/{project_id}/signals/reports/{id}/state/ signals_reports_state_create
Transition a report to a new state. The model validates allowed transitions.
The request body is validated by SignalReportStateRequestSerializer — only the
fields it declares (state, dismissal_reason, dismissal_note, snooze_for) are read,
and only snooze_for is ever forwarded to transition_to. Any other key is ignored,
so internal transition_to kwargs (reset_weight, error, ...) can't be injected.
Body: {
"state": "suppressed" | "potential",
# Optional dismissal feedback (honored when state == "suppressed" or "potential"):
"dismissal_reason": "<canonical reason code, see SIGNAL_REPORT_DISMISSAL_REASON_CHOICES>",
"dismissal_note": "free-form text",
# Optional, only honored for state == "potential":
"snooze_for": <number of additional signals before re-promotion>,
}
- id path required
- A UUID string identifying this signal report.
- string
- project_id path required
- Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
- string
Try it
Authentication
Configure credentials for PostHog API
Code snippet
Updates live as you fill in the form above.
TypeScript
import posthog from '@utdk/posthog';
await posthog.signalsReportsStateCreate()