Signals
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
POST | |
POST | |
GET | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
GET | |
POST | |
GET |
List all signals scout report check
Every check on one report, newest first. The report_id is the only input. Read this before writing one: a report already carrying a check for the same claim needs no second one, and a report holds at most five open checks at a time.
Required API key scopes
signal_scout_report:writeQuery parameters
- report_idstring
Example request
GET /api /projects /:project_id /signals /scout /runs /report-checksExample response
Status 200 The report's checks, newest first.
Status 400 The report does not exist for this project.
Retrieve signals scout scratchpad
Return SignalScratchpad entries for this project, newest-first. ILIKE matches on content and key; pass key instead for an exact single-entry lookup, and skill_name to keep the entries one scout (or pipeline:* stage) created. date_from / date_to are a half-open window on updated_at (>= date_from, < date_to); pass date_to (the updated_at of the oldest entry seen) on subsequent calls to walk past the cap. Entries whose expires_at has passed are excluded unless include_expired=true, and are hard-deleted by a daily janitor once their expiry is more than two weeks in the past. Pass keys_only=true to scan keys without pulling entry bodies, or content_max_chars to cap each content to a preview — both keep a wide orientation scan from returning every entry's full prose. Results capped at 1000.
Required API key scopes
signal_scout:readQuery parameters
- content_max_charsinteger
- date_fromstring
- date_tostring
- include_expiredbooleanDefault:
false - keystring
- keys_onlyboolean
- limitinteger
- skill_namestring
- textstring
Example request
GET /api /projects /:project_id /signals /scout /scratchpadExample response
Status 200 Matching memory entries newest-first.
Create signals scout scratchpad
Upsert a memory keyed on (team, key). Re-using a key updates the existing entry in place. A write carries the entry's whole state, so expires_at is set when passed and cleared when omitted.
Required API key scopes
signal_scratchpad_internal:writeRequest parameters
- keystring
- contentstring
- run_idstring | null
- expires_atstring | null
Response
Example request
POST /api /projects /:project_id /signals /scout /scratchpadExample response
Status 200 Memory entry written or refreshed.
Status 400 Invalid memory shape (empty key/content, key too long, or an `expires_at` on a `followup:` entry). An unparseable or past `expires_at` is dropped, not rejected.
Create signals scout scratchpad
Delete an entry by key. Returns deleted=false if no row matched.
Required API key scopes
signal_scratchpad_internal:writeRequest parameters
- keystring
Response
Example request
POST /api /projects /:project_id /signals /scout /scratchpad /forgetExample response
Status 200 Whether a row was removed.
List all signals scout suggestions
Return the pre-computed scout suggestions for this project: up to five picks, best first, each either a PostHog-authored scout to turn on or a drafted custom scout. Dismissed and already-created suggestions are omitted. An empty items with status empty means no batch has been generated yet; the interactive scout-chat-tasks path still works.
Required API key scopes
signal_scout:readResponse
Example request
GET /api /projects /:project_id /signals /scout /suggestionsExample response
Status 200 The current batch.
Create signals scout suggestions
Hide one suggestion from this project's batch. Dismissal is remembered across refreshes by skill name, so the same suggestion is not shown again.
Required API key scopes
signal_scout:writePath parameters
- idstring
Response
Example request
POST /api /projects /:project_id /signals /scout /suggestions /:id /dismissExample response
Status 200 The dismissed suggestion.
Status 404 No suggestion with that id in this project's batch.
Create signals scout suggestions
Re-run the suggestion scan for this project now instead of waiting for the scheduled refresh. Runs headlessly; poll the list endpoint for the new batch (generated_at advances). Capped per project per day.
Required API key scopes
signal_scout:writeResponse
Example request
POST /api /projects /:project_id /signals /scout /suggestions /refreshExample response
Status 202 Refresh dispatched.
Status 403 Organization has not approved AI data processing, or suggestions are off for this project.
Status 409 A refresh is already running for this project.
Status 429 Daily refresh cap reached.
List all signals source configs
Required API key scopes
inbox:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /signals /source_configsExample response
Status 200
Create signals source configs
Required API key scopes
inbox:writeRequest parameters
- source_product
- source_type
- enabledboolean
- configobject
- config_setobject
- config_removearray
Response
Example request
POST /api /projects /:project_id /signals /source_configsExample response
Status 201
Retrieve signals source configs
Required API key scopes
inbox:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /signals /source_configs /:idExample response
Status 200
Update signals source configs
Required API key scopes
inbox:writePath parameters
- idstring
Request parameters
- source_product
- source_type
- enabledboolean
- configobject
- config_setobject
- config_removearray
Response
Example request
PATCH /api /projects /:project_id /signals /source_configs /:idExample response
Status 200
Delete signals source configs
Required API key scopes
inbox:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /signals /source_configs /:idExample response
Status 204 No response body
Create signals source configs alert pattern preview
Check allow and block patterns for the product analytics source before saving them. Returns why each list would be rejected, and what the patterns do to the project's enabled alerts: which ones they let through and which ones they drop. Saves nothing.
Required API key scopes
inbox:readRequest parameters
- alert_allow_patternsarray
- alert_block_patternsarray
Response
Example request
POST /api /projects /:project_id /signals /source_configs /alert_pattern_previewExample response
Status 200
Retrieve signals source
Required API key scopes
signal_usage:readExample request
GET /api /projects /:project_id /signals /source_spendExample response
Status 200
Retrieve signals spend
Required API key scopes
signal_usage:readResponse
Example request
GET /api /projects /:project_id /signals /spendExample response
Status 200
List all signals trial
Required API key scopes
project:readResponse
Example request
GET /api /projects /:project_id /signals /trialExample response
Status 200
Create signals trial
Required API key scopes
project:writeResponse
Example request
POST /api /projects /:project_id /signals /trialExample response
Status 201
Retrieve signals monthly
Required API key scopes
signal_usage:readQuery parameters
- monthstring
Response
Example request
GET /api /projects /:project_id /signals /usage




