Signals

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

POST
POST
POST
POST
GET
POST
GET
POST
GET
GET
GET
GET
POST
POST
POST
GET
POST
POST
GET
POST

Create signals scout submit monitoring

Submit the assigned Monitoring check's evidence and verdict while the scout is running. Only the owning Monitoring scout can call this endpoint. The server derives the check, attempt, definition, and fixed window from the run. Validation errors record nothing: correct the fields and retry in the same run. An identical accepted submission is idempotent. This records an evaluation and leaves the report in Monitoring.

Required API key scopes

signal_scout_monitoring:write

Path parameters

  • run_id
    string

Request parameters

  • evidence_status
  • evidence_reason
    string
  • expectation_matches
    boolean | null
  • explanation
    string
  • evidence_refs
    array

Response


Example request

POST /api/projects/:project_id/signals/scout/runs/:run_id/monitoring_result
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/:run_id/monitoring_result/\
-d evidence_status=undefined,\
-d evidence_reason="string",\
-d expectation_matches="boolean",\
-d explanation="string",\
-d evidence_refs="array"

Example response

Status 200
RESPONSE
{
"accepted": true,
"result_id": "cd1ea384-5045-47f3-9678-d1fc6f8c8581",
"outcome": "passed"
}
Status 400 Invalid result or an assignment that is no longer eligible.
Status 404 The caller does not own this Monitoring run.
Status 409 A different result was already submitted for this assignment.

Create signals scout record

The structured-output channel: record schema-validated records this run produced. Opt-in via the scout config's structured_output_schema (a JSON Schema describing one record) — without it the call fails closed, as it does for a dry-run scout (emit off). All-or-nothing: any invalid record fails the whole call with nothing written, so fix and resubmit the batch. Each accepted record lands in the project's event stream as a $scout_structured_output event — query them like any event (insights, SQL over events). Recording is idempotent: event ids are deterministic, so resubmitting an identical batch (e.g. retrying after a 503) cannot double-count.

Required API key scopes

signal_scout_internal:write

Path parameters

  • run_id
    string

Request parameters

  • records
    Click to open
    array

Response


Example request

POST /api/projects/:project_id/signals/scout/runs/:run_id/record-output
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/:run_id/record-output/\
-d records="array"

Example response

Status 200 All records validated against the configured schema and recorded as events.
RESPONSE
{
"recorded_count": 0,
"record_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Status 400 No structured_output_schema configured for this scout, the channel is off (dry-run scout, org AI-processing consent missing, or the signals_scout source disabled), a record failed schema validation (nothing written), or a batch/size cap was exceeded.
Status 404 Run not found for this project.
Status 503 The records validated but event delivery failed; nothing was recorded. Retry the same call — delivery is idempotent, so a retry cannot double-count.

Create signals scout report check

Stop a check that is no longer worth running — the claim it re-measures has changed, or a better check replaces it. Results it already recorded stay on the report. A check that has already finished cannot be cancelled.

Required API key scopes

signal_scout_report:write

Path parameters

  • run_id
    string

Request parameters

  • check_id
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/runs/:run_id/report-check-cancel
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/:run_id/report-check-cancel/\
-d check_id="string"

Example response

Status 200 Check cancelled.
RESPONSE
{
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"title": "string",
"kind": "string",
"status": "string",
"next_run_at": "2019-08-24T14:15:22Z",
"last_outcome": "string",
"last_outcome_reason": "string",
"run_state": "string",
"waiting_on_run": true,
"dispatched_run_id": "0d40720c-3ac9-4b33-96ee-ba348f818515",
"dispatched_at": "2019-08-24T14:15:22Z"
}
Status 400 The check does not exist for this project, or already finished and cannot be cancelled.
Status 404 Run not found for this project.

Create signals scout report check

Schedule a re-measurement of a report's claim, so whether the fix held becomes a stored fact instead of something a future run has to remember to look for. A metric_threshold check runs one bounded Trends query and compares the result. An agent check runs a scout instead, for a claim no single number settles.

Required API key scopes

signal_scout_report:write

Path parameters

  • run_id
    string

Request parameters

  • title
    string
  • rationale
    string
  • kind
  • config
  • next_run_at
    string
  • run_interval_minutes
    integer | null
  • runs_remaining
    integer
  • expires_at
    string
  • report_id
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/runs/:run_id/report-check-create
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/:run_id/report-check-create/\
-d title="string",\
-d kind=undefined,\
-d config=undefined,\
-d report_id="string"

Example response

Status 200 Check written on the report.
RESPONSE
{
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"title": "string",
"kind": "string",
"status": "string",
"next_run_at": "2019-08-24T14:15:22Z",
"last_outcome": "string",
"last_outcome_reason": "string",
"run_state": "string",
"waiting_on_run": true,
"dispatched_run_id": "0d40720c-3ac9-4b33-96ee-ba348f818515",
"dispatched_at": "2019-08-24T14:15:22Z"
}
Status 400 The report does not exist for this project, the config does not match the kind, the named metric is not on the report, or the report is already at its check limit.
Status 404 Run not found for this project.

List all signals scout report checks

Every check on one report, newest first. 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:write

Path parameters

  • run_id
    string

Query parameters

  • report_id
    string

Example request

GET /api/projects/:project_id/signals/scout/runs/:run_id/report-checks
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/:run_id/report-checks/

Example response

Status 200 The report's checks, newest first.
RESPONSE
{
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"title": "string",
"kind": "string",
"status": "string",
"next_run_at": "2019-08-24T14:15:22Z",
"last_outcome": "string",
"last_outcome_reason": "string",
"run_state": "string",
"waiting_on_run": true,
"dispatched_run_id": "0d40720c-3ac9-4b33-96ee-ba348f818515",
"dispatched_at": "2019-08-24T14:15:22Z"
}
Status 400 The report does not exist for this project.
Status 404 Run not found for this project.

Create signals scout runs emissions

Batched form of the per-run emissions endpoint: return the findings every requested SignalScoutRun emitted, flattened newest-first, in a single request. Each row carries its run_id, so the caller can regroup by run. The findings UI uses this to load the whole recent window in one round-trip instead of one request per run. Strictly team-scoped — run ids belonging to another team contribute no rows (no per-run 404; one stale id never fails the batch).

Required API key scopes

signal_scout:read

Request parameters

  • run_ids
    array

Example request

POST /api/projects/:project_id/signals/scout/runs/emissions/batch
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/emissions/batch/\
-d run_ids="array"

Example response

Status 200 Findings emitted across all requested runs, newest first.
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"run_id": "string",
"finding_id": "string",
"description": "string",
"severity": "P0",
"tags": [
"string"
],
"source_id": "string",
"emitted_at": "2019-08-24T14:15:22Z"
}

Retrieve signals scout runs recent

Return the team's recently emitted scout findings across every run, newest first — the cross-run counterpart to the per-run emissions action. Each row carries its run_id, so you can regroup by run without first listing runs and fanning out one emissions call each. Pass skill_name to scope to a single scout, and date_from / date_to (a half-open window on emitted_at) to bound or paginate — set date_to to the oldest emission's emitted_at to walk back past the limit. Pure Postgres, no ClickHouse round-trip. Capped at 200 rows (default 50).

Required API key scopes

signal_scout:read

Query parameters

  • date_from
    string
  • date_to
    string
  • limit
    integer
  • skill_name
    string

Example request

GET /api/projects/:project_id/signals/scout/runs/emissions/recent
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/emissions/recent/

Example response

Status 200 Recent emitted findings across every run on the team, newest first.
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"run_id": "string",
"finding_id": "string",
"description": "string",
"severity": "P0",
"tags": [
"string"
],
"source_id": "string",
"emitted_at": "2019-08-24T14:15:22Z"
}

Create signals scout runs emission reports

Batched form of the per-run emission-reports endpoint. For every finding the requested runs emitted, resolve the inbox SignalReport (if any) its signal grouped into — all in a single ClickHouse round-trip rather than one query per run, which is what made the findings page slow to open. report is null when a finding hasn't grouped yet, was de-duplicated, or its signal was deleted. Strictly team-scoped — run ids belonging to another team contribute no rows.

Required API key scopes

signal_scout:readinbox:read

Request parameters

  • run_ids
    array

Example request

POST /api/projects/:project_id/signals/scout/runs/emissions/reports/batch
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/emissions/reports/batch/\
-d run_ids="array"

Example response

Status 200 Per-finding inbox report links across all requested runs, newest finding first.
RESPONSE
{
"finding_id": "string",
"source_id": "string",
"report": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "string"
}
}

Retrieve signals scout runs findings

Return a cheap fleet-wide tally of the output the scout troop produced in the recent window — the finding count, the distinct reports authored/edited via the report channel, the number of distinct scouts behind them, and the latest output time. Backs the 'Scout findings' callout so it renders from one query instead of the client paging through the whole runs window. Counts runs that emitted at least one finding (emitted_count > 0) or authored/edited an inbox report within the last window_hours (default 72), capped to the most recent 120 such runs so the count matches what the findings list renders. Strictly team-scoped.

Required API key scopes

signal_scout:read

Query parameters

  • window_hours
    integer

Response


Example request

GET /api/projects/:project_id/signals/scout/runs/findings/summary
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/findings/summary/

Example response

Status 200 Fleet-wide tally of recent scout output — findings and report activity.
RESPONSE
{
"count": 0,
"scout_count": 0,
"authored_report_count": 0,
"edited_report_count": 0,
"run_count": 0,
"latest_at": "2019-08-24T14:15:22Z"
}

Retrieve signals scout runs recent per

Return the most recent per_scout_limit runs of every configured scout on the project (default 25), newest-first across the fleet. The per-scout probe is the point: a fleet-wide time window has to serve hourly and weekly scouts from one result cap, so the busy scouts crowd out the sparse ones and a scout's visible history shrinks as the rest of the fleet gets busier. Probing each skill_name gives every scout the same depth of history whatever its schedule, and bounds the response at scouts x per_scout_limit rather than at the fleet's run rate. Only scouts that still have a config are covered, so runs left behind by a deleted or renamed scout are excluded. Runs older than the staleness guard are excluded too, so a scout that stopped running reads as stale instead of healthy — max_age_days (default 30) is that guard's floor, which each scout's own cadence extends. Use list instead when you want a literal time window or a text/emitted filter. Pass skill_name to probe one scout only. Strictly team-scoped.

Required API key scopes

signal_scout:read

Query parameters

  • max_age_days
    integer
  • per_scout_limit
    integer
  • skill_name
    string

Example request

GET /api/projects/:project_id/signals/scout/runs/recent-per-scout
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/recent-per-scout/

Example response

Status 200 Each scout's most recent runs, newest-first across the fleet.
RESPONSE
{
"total_spend": 0,
"run_id": "string",
"skill_name": "string",
"skill_version": 0,
"status": "not_started",
"created_at": "string",
"started_at": "string",
"completed_at": "string",
"task_id": "string",
"task_run_id": "string",
"task_url": "string",
"summary": "string",
"error": "string",
"failure_reason": "string",
"emitted_count": 0,
"emitted_finding_ids": [
"string"
],
"emitted_report_ids": [
"string"
],
"edited_report_ids": [
"string"
],
"metadata": {
"harness_prompt_version": "string",
"report_channel": "string",
"skill_origin": "string",
"github_guidance": true,
"business_knowledge_maintained": true,
"model": "string",
"runtime_adapter": "string",
"reasoning_effort": "string",
"service_tier": "string",
"network_access": "string",
"write_scopes": [
"string"
],
"report_actions": [
"string"
],
"report_action_starts": [
{
"at": "string",
"report_id": "string",
"action": "string"
}
],
"triggered_by": "string",
"run_note": "string",
"derived": {
"has_emit_report": true,
"has_edit_report": true,
"has_self_improvement": true,
"has_chart": true,
"has_self_validation": true,
"has_structured_output": true,
"has_not_in_use_closeout": true
}
}
}
Status 304 The runs match the `ETag` sent in `If-None-Match`, so the body is left out.
Status 412 The runs do not match the `ETag` sent in `If-Match`.

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:write

Query parameters

  • report_id
    string

Example request

GET /api/projects/:project_id/signals/scout/runs/report-checks
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/runs/report-checks/

Example response

Status 200 The report's checks, newest first.
RESPONSE
{
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"title": "string",
"kind": "string",
"status": "string",
"next_run_at": "2019-08-24T14:15:22Z",
"last_outcome": "string",
"last_outcome_reason": "string",
"run_state": "string",
"waiting_on_run": true,
"dispatched_run_id": "0d40720c-3ac9-4b33-96ee-ba348f818515",
"dispatched_at": "2019-08-24T14:15:22Z"
}
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, key_prefix to keep the entries whose key starts with a prefix, 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. Pass include_revisions=true with key to also get the entry's earlier versions, newest first, including those of a deleted key. A key search also reports who last changed the entry, and returns an entry hidden only by its expiry as an expired marker with blank content instead of nothing. Results capped at 1000.

Required API key scopes

signal_scout:read

Query parameters

  • content_max_chars
    integer
  • date_from
    string
  • date_to
    string
  • include_expired
    boolean
    Default: false
  • include_revisions
    boolean
    Default: false
  • key
    string
  • key_prefix
    string
  • keys_only
    boolean
  • limit
    integer
  • skill_name
    string
  • text
    string

Example request

GET /api/projects/:project_id/signals/scout/scratchpad
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/scratchpad/

Example response

Status 200 Matching memory entries newest-first.
RESPONSE
{
"key": "string",
"content": "string",
"created_at": "string",
"updated_at": "string",
"expires_at": "string",
"created_by_run_id": "string",
"created_by_skill": "string",
"created_by_run_url": "string",
"revisions": [
{
"content": "string",
"expires_at": "string",
"change": "overwrite",
"changed_at": "string",
"changed_by_run_id": "string",
"changed_by_skill": "string",
"changed_by_run_url": "string"
}
],
"expired": true,
"last_changed_by_skill": "string",
"last_changed_at": "string",
"revived_expiry": {
"expires_at": "string",
"set_by_skill": "string",
"set_at": "string"
}
}

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. Pass if_updated_at to write only when the entry is still the one you read. A write onto an expired entry succeeds, and the response's revived_expiry reports the expiry it replaced.

Required API key scopes

signal_scratchpad_internal:write

Request parameters

  • key
    string
  • content
    string
  • run_id
    string | null
  • expires_at
    string | null
  • if_updated_at
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/scratchpad
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/scratchpad/\
-d key="string",\
-d content="string"

Example response

Status 200 Memory entry written or refreshed.
RESPONSE
{
"key": "string",
"content": "string",
"created_at": "string",
"updated_at": "string",
"expires_at": "string",
"created_by_run_id": "string",
"created_by_skill": "string",
"created_by_run_url": "string",
"revisions": [
{
"content": "string",
"expires_at": "string",
"change": "overwrite",
"changed_at": "string",
"changed_by_run_id": "string",
"changed_by_skill": "string",
"changed_by_run_url": "string"
}
],
"expired": true,
"last_changed_by_skill": "string",
"last_changed_at": "string",
"revived_expiry": {
"expires_at": "string",
"set_by_skill": "string",
"set_at": "string"
}
}
Status 400 Invalid memory shape (empty key/content, key too long, an `expires_at` on a `followup:` entry, or an unparseable `if_updated_at`). An unparseable or past `expires_at` is dropped, not rejected.
Status 409 `if_updated_at` did not match: the entry changed since it was read, or no entry has this key. Nothing was written.
RESPONSE
{
"detail": "string",
"updated_at": "string"
}

Create signals scout scratchpad

Delete one scout memory by its exact key, so no scout reads it again. Use this to prune entries a skill change left stale. Returns deleted=false if no entry has that key. Requires editor access to skills, because the scratchpad steers the scout agents.

Required API key scopes

signal_scout:writellm_skill:write

Request parameters

  • key
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/scratchpad/discard
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/scratchpad/discard/\
-d key="string"

Example response

Status 200 Whether a row was removed.
RESPONSE
{
"deleted": true
}
Status 403 The caller lacks editor access to skills.

Create signals scout scratchpad

Delete an entry by key. Returns deleted=false if no row matched.

Required API key scopes

signal_scratchpad_internal:write

Request parameters

  • key
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/scratchpad/forget
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/scratchpad/forget/\
-d key="string"

Example response

Status 200 Whether a row was removed.
RESPONSE
{
"deleted": true
}

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:read

Response


Example request

GET /api/projects/:project_id/signals/scout/suggestions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/suggestions/

Example response

Status 200 The current batch.
RESPONSE
{
"status": "fresh",
"generated_at": "2019-08-24T14:15:22Z",
"model": "string",
"fleet_snapshot": [
"string"
],
"items": [
{
"id": "string",
"kind": "canonical",
"skill_name": "string",
"title": "string",
"why_here": "string",
"description": "string",
"draft_body": "string",
"proposed_config": {
"run_cron_schedule": "string",
"run_interval_minutes": 0,
"emit": true
},
"gap": true,
"confidence": "low"
}
]
}

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:write

Path parameters

  • id
    string

Response


Example request

POST /api/projects/:project_id/signals/scout/suggestions/:id/dismiss
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/suggestions/:id/dismiss/

Example response

Status 200 The dismissed suggestion.
RESPONSE
{
"id": "string",
"kind": "canonical",
"skill_name": "string",
"title": "string",
"why_here": "string",
"description": "string",
"draft_body": "string",
"proposed_config": {
"run_cron_schedule": "string",
"run_interval_minutes": 0,
"emit": true
},
"gap": true,
"confidence": "low"
}
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:write

Response


Example request

POST /api/projects/:project_id/signals/scout/suggestions/refresh
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/suggestions/refresh/

Example response

Status 202 Refresh dispatched.
RESPONSE
{
"workflow_id": "string"
}
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:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/signals/source_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/source_configs/

Example response

Status 200
RESPONSE
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true,
"config": {},
"config_set": {},
"config_remove": [
"string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"status": "running",
"filter_status": {
"state": "ok",
"error_code": "string",
"error_message": "string",
"failed_at": "2019-08-24T14:15:22Z",
"unread_since": "2019-08-24T14:15:22Z",
"last_success_at": "2019-08-24T14:15:22Z",
"malformed_count": 0
}
}
]
}

Create signals source configs

Required API key scopes

inbox:write

Request parameters

  • source_product
  • source_type
  • enabled
    boolean
  • config
    object
  • config_set
    object
  • config_remove
    array

Response


Example request

POST /api/projects/:project_id/signals/source_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/source_configs/\
-d source_product=undefined,\
-d source_type=undefined

Example response

Status 201
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true,
"config": {},
"config_set": {},
"config_remove": [
"string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"status": "running",
"filter_status": {
"state": "ok",
"error_code": "string",
"error_message": "string",
"failed_at": "2019-08-24T14:15:22Z",
"unread_since": "2019-08-24T14:15:22Z",
"last_success_at": "2019-08-24T14:15:22Z",
"malformed_count": 0
}
}