Signals

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

Endpoints

GET
GET
GET
GET
POST
GET
GET
POST
GET
GET
GET
POST
POST
POST
GET
DELETE
GET
POST
GET

List all signals activity summary

Required API key scopes

task:read

Response


Example request

GET /api/projects/:project_id/signals/activity_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/activity_summary/

Example response

Status 200
RESPONSE
{
"status": "ready",
"headline": "string",
"profile": "string",
"themes": [
{
"label": "string",
"mode": "building",
"strength": "string",
"refs": [
"string"
],
"last_seen": "string"
}
],
"modes": [
"building"
],
"recent_shift": "string",
"computed": {
"schema_version": 0,
"owned": [
{
"ref": "string",
"type": "string",
"id": "string",
"name": "string",
"edit_days": 0,
"last_at": "string",
"created": true
}
],
"watched": [
{
"ref": "string",
"type": "string",
"id": "string",
"name": "string",
"open_days": 0,
"last_at": "string",
"not_theirs": true
}
],
"pages": [
{
"ref": "string",
"product": "product_analytics",
"open_days": 0,
"last_at": "string"
}
],
"products": {
"works_in": [
"product_analytics"
],
"visits": [
"product_analytics"
]
},
"task_count": 0,
"tasks": [
{
"ref": "string",
"last_at": "string"
}
],
"mcp_sessions": [
{
"ref": "string",
"last_at": "string"
}
]
},
"generated_at": "2019-08-24T14:15:22Z",
"version": 0,
"prompt_version": 0,
"stale": true
}

Retrieve signals activity summary versions

Required API key scopes

task:read

Query parameters

  • limit
    integer
    Default: 5
  • version
    integer

Example request

GET /api/projects/:project_id/signals/activity_summary/versions
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/activity_summary/versions/

Example response

Status 200
RESPONSE
{
"version": 0,
"generated_at": "2019-08-24T14:15:22Z",
"prompt_version": 0,
"headline": "string",
"recent_shift": "string",
"themes": [
{
"label": "string",
"mode": "building",
"strength": "string",
"refs": [
"string"
],
"last_seen": "string"
}
],
"modes": [
"building"
],
"profile": "string",
"computed": {
"schema_version": 0,
"owned": [
{
"ref": "string",
"type": "string",
"id": "string",
"name": "string",
"edit_days": 0,
"last_at": "string",
"created": true
}
],
"watched": [
{
"ref": "string",
"type": "string",
"id": "string",
"name": "string",
"open_days": 0,
"last_at": "string",
"not_theirs": true
}
],
"pages": [
{
"ref": "string",
"product": "product_analytics",
"open_days": 0,
"last_at": "string"
}
],
"products": {
"works_in": [
"product_analytics"
],
"visits": [
"product_analytics"
]
},
"task_count": 0,
"tasks": [
{
"ref": "string",
"last_at": "string"
}
],
"mcp_sessions": [
{
"ref": "string",
"last_at": "string"
}
]
}
}


Retrieve signals anomalies insight

Read-only anomaly rates of the saved trends insights that anomaly scoring checks.

Required API key scopes

insight:read

Query parameters

  • date_from
    string
    Default: -30d
  • date_to
    string
  • include_buckets
    boolean
    Default: true
  • include_warmup
    boolean
    Default: false
  • insight_id
    integer
  • series_key
    string

Response


Example request

GET /api/projects/:project_id/signals/anomalies/insight
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/anomalies/insight/

Example response

Status 200
RESPONSE
{
"scoring_enabled": true,
"insight_id": 0,
"insight_name": "string",
"insight_url": "string",
"interval": "hour",
"profile": "string",
"detector": "string",
"detector_version": "string",
"series_count": 0,
"flagged_series": 0,
"scored_buckets": 0,
"flagged_buckets": 0,
"anomaly_rate": 0,
"date_from": "2019-08-24T14:15:22Z",
"date_to": "2019-08-24T14:15:22Z",
"series": [
{
"series_key": "string",
"series_label": "string",
"breakdown_value": "string",
"scored_buckets": 0,
"flagged_buckets": 0,
"anomaly_rate": 0,
"expected_buckets": 0,
"coverage": 0,
"last_flagged_bucket": "2019-08-24T14:15:22Z",
"buckets": [
{
"bucket_start": "2019-08-24T14:15:22Z",
"scored": true,
"value": 0,
"score": 0,
"flag": true,
"scored_at": "2019-08-24T14:15:22Z",
"details": {}
}
]
}
],
"truncated": true,
"message": "string"
}
Status 404 The insight does not exist or the user cannot read it.

Create signals anomalies points

Read-only anomaly rates of the saved trends insights that anomaly scoring checks.

Required API key scopes

insight:read

Request parameters

  • series
    Click to open
    array

Response


Example request

POST /api/projects/:project_id/signals/anomalies/points
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/anomalies/points/\
-d series="array"

Example response

Status 200
RESPONSE
{
"date_to": "2019-08-24T14:15:22Z",
"series": [
{
"insight_id": 0,
"series_key": "string",
"interval": "hour",
"date_from": "2019-08-24T14:15:22Z",
"points": [
{
"bucket_start": "2019-08-24T14:15:22Z",
"value": 0,
"flag": true
}
]
}
]
}


List all signals config

Team-level signal autonomy config (singleton per team).

GET /signals/config/ → retrieve POST /signals/config/ → update

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/config
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/config/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"autostart_enabled": true,
"default_autostart_priority": "P0",
"default_slack_notification_channel": "string",
"default_slack_notification_min_priority": "P0",
"default_slack_notification_integration": 0,
"autostart_base_branches": {
"property1": "string",
"property2": "string"
},
"scout_instructions": "string",
"research_instructions": "string",
"implementation_instructions": "string",
"scout_custom_image_id": "4f562c4c-430b-4e86-8720-fc073c740753",
"research_custom_image_id": "bbe8eb4f-79ac-444e-b4f5-57929bdb50cb",
"implementation_custom_image_id": "43581cc8-2200-4baf-9d2b-9dc91591aadb",
"issue_tracking_integration": 0,
"issue_tracking_config": {
"property1": "string",
"property2": "string"
},
"max_reports_per_day": 1,
"default_open_pull_request_ready": true,
"github_issue_writeback_enabled": true,
"pull_request_label_enabled": true,
"pull_request_label": "string",
"implementation_repositories": [
"string"
],
"anomaly_scoring_enabled": true,
"anomaly_scoring_available": true,
"reports_generated_today": 0,
"daily_report_limit_reached": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Create signals config

Partial update of the per-project singleton. Omitted fields keep their value.

Required API key scopes

inbox:write

Request parameters

  • autostart_enabled
    boolean | null
  • default_autostart_priority
  • default_slack_notification_channel
    string | null
  • default_slack_notification_min_priority
  • default_slack_notification_integration
    integer | null
  • autostart_base_branches
    object
  • scout_instructions
    string
  • research_instructions
    string
  • implementation_instructions
    string
  • scout_custom_image_id
    string | null
  • research_custom_image_id
    string | null
  • implementation_custom_image_id
    string | null
  • issue_tracking_integration
    integer | null
  • issue_tracking_config
    object
  • max_reports_per_day
    integer | null
  • default_open_pull_request_ready
    boolean
  • github_issue_writeback_enabled
    boolean
  • pull_request_label_enabled
    boolean
  • pull_request_label
    string | null
  • implementation_repositories
    array
  • anomaly_scoring_enabled
    boolean

Response


Example request

POST /api/projects/:project_id/signals/config
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/config/\
-d autostart_enabled="boolean"

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"autostart_enabled": true,
"default_autostart_priority": "P0",
"default_slack_notification_channel": "string",
"default_slack_notification_min_priority": "P0",
"default_slack_notification_integration": 0,
"autostart_base_branches": {
"property1": "string",
"property2": "string"
},
"scout_instructions": "string",
"research_instructions": "string",
"implementation_instructions": "string",
"scout_custom_image_id": "4f562c4c-430b-4e86-8720-fc073c740753",
"research_custom_image_id": "bbe8eb4f-79ac-444e-b4f5-57929bdb50cb",
"implementation_custom_image_id": "43581cc8-2200-4baf-9d2b-9dc91591aadb",
"issue_tracking_integration": 0,
"issue_tracking_config": {
"property1": "string",
"property2": "string"
},
"max_reports_per_day": 1,
"default_open_pull_request_ready": true,
"github_issue_writeback_enabled": true,
"pull_request_label_enabled": true,
"pull_request_label": "string",
"implementation_repositories": [
"string"
],
"anomaly_scoring_enabled": true,
"anomaly_scoring_available": true,
"reports_generated_today": 0,
"daily_report_limit_reached": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List all signals inbox status

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/inbox_status
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/inbox_status/

Example response

Status 200
RESPONSE
{
"setup_state": "not_started",
"has_report_history": true,
"first_report_status": "pending",
"can_configure": true
}

List all signals inbox summary

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/inbox_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/inbox_summary/

Example response

Status 200
RESPONSE
{
"period_start": "2019-08-24T14:15:22Z",
"period_end": "2019-08-24T14:15:22Z",
"merged_pr_count": 0,
"people_count": 0,
"participation_complete": true,
"pull_requests": [
{
"repository": "string",
"number": 0,
"url": "http://example.com"
}
],
"people": [
{
"id": 0,
"login": "string"
}
]
}

List all signals onboarding

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/onboarding
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/onboarding/

Example response

Status 200
RESPONSE
{
"github_optional_available": true,
"setup_default_skills": [
"string"
],
"first_report_completion_notification": true,
"first_report_notification_email": "user@example.com",
"first_report": {
"scout_run_id": "149ec62a-a3b4-4bd4-8aaa-05a3c90969d1",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_run_id": "7f0ef9d7-e7b5-4d52-8247-ce8351652f8b",
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"checked_products": [
"string"
],
"missing_data": [
"string"
]
},
"jobs": {
"scout": "pending",
"recommendations": "pending"
},
"draft": {
"onboarding_origin": "app",
"activation_mode": "github_optional",
"step": "signals",
"setup_mode": "quick",
"sources": [
{
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true
}
],
"scanner_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"suggestions": [
{
"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"
}
],
"activation_scouts": [
"string"
],
"automatic_implementation": true,
"implementation_priority": "P0"
},
"completed_at": "2019-08-24T14:15:22Z"
}

Create signals onboarding

Required API key scopes

inbox:write

Request parameters

  • onboarding_origin
  • activation_mode
  • step
  • setup_mode
  • sources
    Click to open
    array
  • scanner_ids
    array
  • suggestions
    Click to open
    array
  • activation_scouts
    array
  • automatic_implementation
    boolean
  • implementation_priority

Response


Example request

POST /api/projects/:project_id/signals/onboarding
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/onboarding/\
-d step=undefined,\
-d sources="array",\
-d scanner_ids="array",\
-d suggestions="array",\
-d automatic_implementation="boolean",\
-d implementation_priority=undefined

Example response

Status 201
RESPONSE
{
"github_optional_available": true,
"setup_default_skills": [
"string"
],
"first_report_completion_notification": true,
"first_report_notification_email": "user@example.com",
"first_report": {
"scout_run_id": "149ec62a-a3b4-4bd4-8aaa-05a3c90969d1",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_run_id": "7f0ef9d7-e7b5-4d52-8247-ce8351652f8b",
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"checked_products": [
"string"
],
"missing_data": [
"string"
]
},
"jobs": {
"scout": "pending",
"recommendations": "pending"
},
"draft": {
"onboarding_origin": "app",
"activation_mode": "github_optional",
"step": "signals",
"setup_mode": "quick",
"sources": [
{
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true
}
],
"scanner_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"suggestions": [
{
"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"
}
],
"activation_scouts": [
"string"
],
"automatic_implementation": true,
"implementation_priority": "P0"
},
"completed_at": "2019-08-24T14:15:22Z"
}

Create signals onboarding complete

Required API key scopes

inbox:write

Request parameters

  • onboarding_origin
  • activation_mode
  • step
  • setup_mode
  • sources
    Click to open
    array
  • scanner_ids
    array
  • suggestions
    Click to open
    array
  • activation_scouts
    array
  • automatic_implementation
    boolean
  • implementation_priority

Response


Example request

POST /api/projects/:project_id/signals/onboarding/complete
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/onboarding/complete/\
-d step=undefined,\
-d sources="array",\
-d scanner_ids="array",\
-d suggestions="array",\
-d automatic_implementation="boolean",\
-d implementation_priority=undefined

Example response

Status 200
RESPONSE
{
"github_optional_available": true,
"setup_default_skills": [
"string"
],
"first_report_completion_notification": true,
"first_report_notification_email": "user@example.com",
"first_report": {
"scout_run_id": "149ec62a-a3b4-4bd4-8aaa-05a3c90969d1",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_run_id": "7f0ef9d7-e7b5-4d52-8247-ce8351652f8b",
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"checked_products": [
"string"
],
"missing_data": [
"string"
]
},
"jobs": {
"scout": "pending",
"recommendations": "pending"
},
"draft": {
"onboarding_origin": "app",
"activation_mode": "github_optional",
"step": "signals",
"setup_mode": "quick",
"sources": [
{
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true
}
],
"scanner_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"suggestions": [
{
"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"
}
],
"activation_scouts": [
"string"
],
"automatic_implementation": true,
"implementation_priority": "P0"
},
"completed_at": "2019-08-24T14:15:22Z"
}

Create signals onboarding expose

Required API key scopes

inbox:write

Request parameters

  • onboarding_origin

Response


Example request

POST /api/projects/:project_id/signals/onboarding/expose
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/onboarding/expose/\
-d onboarding_origin=undefined

Example response

Status 200
RESPONSE
{
"github_optional_available": true,
"setup_default_skills": [
"string"
],
"first_report_completion_notification": true,
"first_report_notification_email": "user@example.com",
"first_report": {
"scout_run_id": "149ec62a-a3b4-4bd4-8aaa-05a3c90969d1",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"task_run_id": "7f0ef9d7-e7b5-4d52-8247-ce8351652f8b",
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"checked_products": [
"string"
],
"missing_data": [
"string"
]
},
"jobs": {
"scout": "pending",
"recommendations": "pending"
},
"draft": {
"onboarding_origin": "app",
"activation_mode": "github_optional",
"step": "signals",
"setup_mode": "quick",
"sources": [
{
"source_product": "session_replay",
"source_type": "session_analysis_cluster",
"enabled": true
}
],
"scanner_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"suggestions": [
{
"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"
}
],
"activation_scouts": [
"string"
],
"automatic_implementation": true,
"implementation_priority": "P0"
},
"completed_at": "2019-08-24T14:15:22Z"
}

List all signals processing

Return current processing state including pause status.

Required API key scopes

inbox:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/signals/processing
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/processing/

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": [
{
"paused_until": "2019-08-24T14:15:22Z"
}
]
}

Delete signals processing pause

View and control signal processing pipeline state for a team.

Required API key scopes

inbox:write

Response


Example request

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

Example response

Status 200
RESPONSE
{
"status": "string",
"paused_until": "2019-08-24T14:15:22Z"
}

List all signals reports

Required API key scopes

inbox:read

Query parameters

  • actionability
    string
  • already_addressed
    boolean
  • assignee
    string
    One of: "me""mine"
  • channel_id
    string
  • connected
    string
  • count_only
    boolean
    Default: false
  • created_after
    string
  • created_before
    string
  • exclude
    array
  • has_implementation_pr
    boolean
  • include_all_statuses
    boolean
  • include_source_metadata
    boolean
    Default: true
  • include_unlisted
    boolean
    Default: false
  • limit
    integer
  • needs_you
    boolean
  • offset
    integer
  • ordering
    string
  • plan
    string
  • priority
    string
  • ranking_id
    string
  • ranking_min_lift
    string
  • ranking_min_probability
    string
  • scope
    string
  • scout
    string
  • scout_prefix
    string
  • search
    string
  • sort
    string
  • source_id
    string
  • source_product
    string
  • status
    string
  • suggested_reviewers
    string
  • tags
    array
  • task_id
    string
  • teammate_uuid
    string
  • unclaimed
    boolean
  • unread
    boolean
  • use_priority_preference
    boolean
  • view
    string

Response


Example request

GET /api/projects/:project_id/signals/reports
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/reports/

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",
"title": "string",
"summary": "string",
"summary_lead": "string",
"reviewer_assignment": {
"state": {
"reviewers_id": "2e0d6f9a-f7b9-4851-80c4-2938b51252f8",
"corrections_id": "d6237cc9-ee4f-4270-9a15-7e959436f098"
},
"pinned_user_uuids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"excluded_user_uuids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"confirmed": true,
"needs_review": true,
"enabled": true
},
"status": "potential",
"monitoring_started_at": "2019-08-24T14:15:22Z",
"monitoring_ended_at": "2019-08-24T14:15:22Z",
"total_weight": 0.1,
"signal_count": 0,
"signals_at_run": 0,
"collapsed_note_count": 0,
"startup_failure": {
"provider": "claude",
"phase": "session_setup",
"reason": "string",
"retryability": "requires_action",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
"message": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"artefact_count": 0,
"charts": [
{
"chart_id": "string",
"title": "string",
"query": null,
"caption": "string",
"size": "small"
}
],
"metrics": [
{
"metric_id": "string",
"title": "string",
"kind": "affected_users",
"role": "supporting",
"value": 0,
"value_at": "2019-08-24T14:15:22Z",
"series": [
0.1
],
"series_buckets": [
"string"
],
"value_format": "number",
"unit": "string",
"caption": "string",
"goal_value": 0,
"goal_direction": "at_most",
"goal_grain": "whole_window",
"decision_window_days": 1,
"minimum_data_points": 1,
"interval": "string"
}
],
"suggested_prompts": [
"string"
],
"tags": [
"string"
],
"source_suggestion": {
"product": "logs",
"reason": "string"
},
"priority": "string",
"actionability": "string",
"already_addressed": true,
"decisions": {
"repository": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "string"
},
"priority": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "P0"
},
"actionability": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "string"
},
"already_addressed": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": true
}
},
"dismissal_reason": "string",
"dismissal_note": "string",
"suppression_source": "dismissed",
"suppression_explanation": "string",
"repo_slug": "string",
"is_self_improvement_report": true,
"research_context": {
"mode": "code",
"repository_status": "available"
},
"is_suggested_reviewer": false,
"source_products": [
"string"
],
"scout_name": "string",
"implementation_pr_url": "string",
"pull_requests": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com",
"state": "unknown",
"merged": true,
"review_decision": "approved",
"merged_at": "2019-08-24T14:15:22Z",
"attached_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
"attached_at": "2019-08-24T14:15:22Z"
}
],
"implementation_pr_state": "unknown",
"implementation_pr_merged": true,
"tracker_issue_url": "string",
"tracker_issue_reference": "string",
"tracker_issue_error": "string",
"source_issues": [
"string"
],
"work_state": "unclaimed",
"assignee": {
"claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"agent": "string",
"claimed_at": "2019-08-24T14:15:22Z",
"responsible_user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
}
},
"implementation_in_flight": true,
"refund": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "pr_incorrect",
"note": "string",
"billing_path": "excluded",
"credits": 0,
"pr_url": "string",
"pr_run_created_at": "2019-08-24T14:15:22Z",
"credit_amount_usd": "string",
"billing_synced": true,
"created_at": "2019-08-24T14:15:22Z"
},
"refund_ineligibility_reason": "already_refunded",
"billing_exempt_reason": "posthog_health_check",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"ranking": {
"status": "scored",
"model": "string",
"scored_at": "2019-08-24T14:15:22Z",
"predictions": [
{
"outcome": "open",
"probability": 0.1,
"lift": 0,
"readable": true
}
]
},
"plan": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"steps": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"depends_on": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"implementation_pr_url": "string",
"implementation_pr_state": "unknown",
"suppression_source": "dismissed"
}
]
},
"inbox_merge_key": 0,
"personal_tier": "string",
"personal_reason": "string",
"monitoring_summary": {
"state": "not_on_track",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"lead_check": {
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"title": "string",
"metric_id": "string",
"metric_kind": "affected_users",
"value_format": "number",
"unit": "string",
"comparison": {
"operator": "lte",
"value": null,
"bounds": null
},
"monitoring": {
"purpose": "expectation",
"reference_period_minutes": 527040,
"threshold_scaling": "linear",
"baseline_period_minutes": null
},
"baseline_value": 0,
"ends_at": "2019-08-24T14:15:22Z",
"next_measurement_at": "2019-08-24T14:15:22Z",
"readings": [
{
"measured_at": "2019-08-24T14:15:22Z",
"matches": true,
"observed_value": 0,
"threshold": 0
}
]
},
"checks": [
{
"check_id": "051490c8-9abf-480a-9348-72c146208cd5",
"title": "string",
"kind": "metric_threshold",
"state": "passed",
"ends_at": "2019-08-24T14:15:22Z"
}
]
},
"monitoring_outcome": {
"kind": "resolved",
"ended_at": "2019-08-24T14:15:22Z",
"follow_up": {
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"title": "string",
"status": "potential"
}
},
"link_summary": {
"kind": "part_of",
"report": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"implementation_pr_url": "string",
"implementation_pr_state": "unknown"
},
"plan": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"steps": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"state": "merged"
}
],
"lead_step_id": "e446eec9-9911-41ce-bdcd-e40a1503f861"
},
"other_links": [
{
"kind": "depends_on",
"report": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"implementation_pr_url": "string",
"implementation_pr_state": "unknown"
}
}
]
}
}
],
"ranker": "string",
"ranking_id": "5b03e172-481e-44bb-968b-0405d329fce9",
"personal_ranking_status": {
"state": "real",
"size": 0,
"age_minutes": 0,
"checked_age_minutes": 0,
"fallback_reason": "string",
"building": true
},
"count_is_capped": true,
"ranking_pill": true,
"source_metadata_available": true
}

Create signals reports

File a complete inbox report yourself, with the same validation and safety judge a scout report passes. The report surfaces at the status actionability implies, or is suppressed. It never starts an implementation run or opens a pull request on its own, now or after a later edit: start one from the report's actions. Safe to retry: a resend returns the first report with idempotent_replay true. Each person can file a limited number of reports per project per day.

Required API key scopes

inbox:write

Request parameters

  • title
    string
  • summary
    string
  • evidence
    Click to open
    array
  • actionability_explanation
    string
  • actionability
  • already_addressed
    boolean
    Default: false
  • repository
    string | null
  • priority
  • priority_explanation
    string | null
  • suggested_reviewers
    Click to open
    array
  • charts
    Click to open
    array
  • metrics
    Click to open
    array
  • suggested_prompts
    array
  • links
    Click to open
    array
  • source_issues
    Click to open
    array
  • tags
    array
  • idempotency_key
    string | null

Response


Example request

POST /api/projects/:project_id/signals/reports
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/reports/\
-d title="string",\
-d summary="string",\
-d evidence="array",\
-d actionability_explanation="string",\
-d actionability=undefined

Example response

Status 200 Nothing new was filed: a retry returned the first report (`idempotent_replay` true).
RESPONSE
{
"report_id": "string",
"report_status": "string",
"emitted": true,
"skipped_reason": "string",
"safety_explanation": "string",
"remediation": "string",
"idempotent_replay": true,
"quality_hints": [
{
"check_id": "string",
"severity": "repair",
"field": "title",
"message": "string"
}
]
}
Status 201 Report filed: READY, PENDING_INPUT, or suppressed by the safety judge.
RESPONSE
{
"report_id": "string",
"report_status": "string",
"emitted": true,
"skipped_reason": "string",
"safety_explanation": "string",
"remediation": "string",
"idempotent_replay": true,
"quality_hints": [
{
"check_id": "string",
"severity": "repair",
"field": "title",
"message": "string"
}
]
}
Status 400 Invalid report shape (empty title, summary, or evidence).
Status 403 The caller is not a person, is a task sandbox, report filing is not enabled, or the organization has not approved AI data processing.
Status 429 The caller filed the daily maximum of reports for this project.

Retrieve signals reports

Required API key scopes

inbox:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/signals/reports/:id
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/reports/:id/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"summary": "string",
"summary_lead": "string",
"reviewer_assignment": {
"state": {
"reviewers_id": "2e0d6f9a-f7b9-4851-80c4-2938b51252f8",
"corrections_id": "d6237cc9-ee4f-4270-9a15-7e959436f098"
},
"pinned_user_uuids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"excluded_user_uuids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"confirmed": true,
"needs_review": true,
"enabled": true
},
"status": "potential",
"monitoring_started_at": "2019-08-24T14:15:22Z",
"monitoring_ended_at": "2019-08-24T14:15:22Z",
"total_weight": 0.1,
"signal_count": 0,
"signals_at_run": 0,
"collapsed_note_count": 0,
"startup_failure": {
"provider": "claude",
"phase": "session_setup",
"reason": "string",
"retryability": "requires_action",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
"message": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"artefact_count": 0,
"charts": [
{
"chart_id": "string",
"title": "string",
"query": null,
"caption": "string",
"size": "small"
}
],
"metrics": [
{
"metric_id": "string",
"title": "string",
"kind": "affected_users",
"role": "supporting",
"value": 0,
"value_at": "2019-08-24T14:15:22Z",
"series": [
0.1
],
"series_buckets": [
"string"
],
"value_format": "number",
"unit": "string",
"query": null,
"caption": "string",
"goal_value": 0,
"goal_direction": "at_most",
"goal_grain": "whole_window",
"decision_window_days": 1,
"minimum_data_points": 1
}
],
"suggested_prompts": [
"string"
],
"tags": [
"string"
],
"source_suggestion": {
"product": "logs",
"reason": "string"
},
"priority": "string",
"actionability": "string",
"already_addressed": true,
"decisions": {
"repository": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "string"
},
"priority": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "P0"
},
"actionability": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": "string"
},
"already_addressed": {
"reason": "string",
"set_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"set_at": "2019-08-24T14:15:22Z",
"value": true
}
},
"dismissal_reason": "string",
"dismissal_note": "string",
"suppression_source": "dismissed",
"suppression_explanation": "string",
"repo_slug": "string",
"is_self_improvement_report": true,
"research_context": {
"mode": "code",
"repository_status": "available"
},
"is_suggested_reviewer": false,
"source_products": [
"string"
],
"scout_name": "string",
"implementation_pr_url": "string",
"pull_requests": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"url": "http://example.com",
"state": "unknown",
"merged": true,
"review_decision": "approved",
"merged_at": "2019-08-24T14:15:22Z",
"attached_by": {
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"agent": "string",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb"
},
"claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
"attached_at": "2019-08-24T14:15:22Z"
}
],
"implementation_pr_state": "unknown",
"implementation_pr_merged": true,
"tracker_issue_url": "string",
"tracker_issue_reference": "string",
"tracker_issue_error": "string",
"source_issues": [
"string"
],
"work_state": "unclaimed",
"assignee": {
"claim_id": "6ed32748-64af-4d95-94ea-a78b6397033c",
"kind": "user",
"user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
},
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"agent": "string",
"claimed_at": "2019-08-24T14:15:22Z",
"responsible_user": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"first_name": "string",
"last_name": "string",
"email": "user@example.com"
}
},
"implementation_in_flight": true,
"refund": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason": "pr_incorrect",
"note": "string",
"billing_path": "excluded",
"credits": 0,
"pr_url": "string",
"pr_run_created_at": "2019-08-24T14:15:22Z",
"credit_amount_usd": "string",
"billing_synced": true,
"created_at": "2019-08-24T14:15:22Z"
},
"refund_ineligibility_reason": "already_refunded",
"billing_exempt_reason": "posthog_health_check",
"channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",
"ranking": {
"status": "scored",
"model": "string",
"scored_at": "2019-08-24T14:15:22Z",
"predictions": [
{
"outcome": "open",
"probability": 0.1,
"lift": 0,
"readable": true
}
]
},
"plan": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"steps": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"depends_on": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"implementation_pr_url": "string",
"implementation_pr_state": "unknown",
"suppression_source": "dismissed"
}
]
}
}