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:readResponse
Example request
GET /api /projects /:project_id /signals /activity_summaryExample response
Status 200
Retrieve signals activity summary versions
Required API key scopes
task:readQuery parameters
- limitintegerDefault:
5 - versioninteger
Example request
GET /api /projects /:project_id /signals /activity_summary /versionsExample response
Status 200
Retrieve signals activity summary members
Find the project members whose activity summary matches a topic, an object or a product, including people who only open the work and never edit it. Returns 404 when the search is not available for this project.
Required API key scopes
signal_scout_internal:readQuery parameters
- active_since_daysinteger
- exclude_user_uuidsarray
- include_profilebooleanDefault:
false - limitintegerDefault:
10 - modestringOne of:
"building""analyzing""monitoring""investigating""operating""experimenting" - object_idstring
- object_relationstringDefault:
anyOne of:"any""owned""watched" - object_typestring
- offsetintegerDefault:
0 - productstringOne of:
"product_analytics""dashboards""web_analytics""session_replay""heatmaps""error_tracking""experiments""feature_flags""early_access_features""surveys""product_tours""notebooks""cohorts""persons""data_management""data_warehouse""data_pipelines""workflows""ai_observability""mcp_analytics""logs""tracing""endpoints""revenue_analytics""customer_analytics""inbox""canvases""support" - querystring
- search_modestringDefault:
hybridOne of:"hybrid""semantic""keyword" - user_uuidsarray
Response
Example request
GET /api /projects /:project_id /signals /activity_summary_members /searchExample response
Status 200
Retrieve signals anomalies insight
Read-only anomaly rates of the saved trends insights that anomaly scoring checks.
Required API key scopes
insight:readQuery parameters
- date_fromstringDefault:
-30d - date_tostring
- include_bucketsbooleanDefault:
true - include_warmupbooleanDefault:
false - insight_idinteger
- series_keystring
Response
Example request
GET /api /projects /:project_id /signals /anomalies /insightExample response
Status 200
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:readRequest parameters
- seriesarray
Response
Example request
POST /api /projects /:project_id /signals /anomalies /pointsExample response
Status 200
Retrieve signals anomalies search
Read-only anomaly rates of the saved trends insights that anomaly scoring checks.
Required API key scopes
insight:readQuery parameters
- dashboard_idinteger
- date_fromstringDefault:
-7d - date_tostring
- group_bystringDefault:
seriesOne of:"series""insight" - include_pointsbooleanDefault:
false - insight_idinteger
- intervalstringOne of:
"hour""day""week""month" - limitintegerDefault:
25 - offsetintegerDefault:
0 - only_flaggedbooleanDefault:
true - orderstringDefault:
unusualOne of:"unusual""recent" - searchstring
Response
Example request
GET /api /projects /:project_id /signals /anomalies /searchExample response
Status 200
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:readResponse
Example request
GET /api /projects /:project_id /signals /configExample response
Status 200
Create signals config
Partial update of the per-project singleton. Omitted fields keep their value.
Required API key scopes
inbox:writeRequest parameters
- autostart_enabledboolean | null
- default_autostart_priority
- default_slack_notification_channelstring | null
- default_slack_notification_min_priority
- default_slack_notification_integrationinteger | null
- autostart_base_branchesobject
- scout_instructionsstring
- research_instructionsstring
- implementation_instructionsstring
- scout_custom_image_idstring | null
- research_custom_image_idstring | null
- implementation_custom_image_idstring | null
- issue_tracking_integrationinteger | null
- issue_tracking_configobject
- max_reports_per_dayinteger | null
- default_open_pull_request_readyboolean
- github_issue_writeback_enabledboolean
- pull_request_label_enabledboolean
- pull_request_labelstring | null
- implementation_repositoriesarray
- anomaly_scoring_enabledboolean
Response
Example request
POST /api /projects /:project_id /signals /configExample response
Status 200
List all signals inbox status
Required API key scopes
inbox:readResponse
Example request
GET /api /projects /:project_id /signals /inbox_statusExample response
Status 200
List all signals inbox summary
Required API key scopes
inbox:readResponse
Example request
GET /api /projects /:project_id /signals /inbox_summaryExample response
Status 200
List all signals onboarding
Required API key scopes
inbox:readResponse
Example request
GET /api /projects /:project_id /signals /onboardingExample response
Status 200
Create signals onboarding
Required API key scopes
inbox:writeRequest parameters
- onboarding_origin
- activation_mode
- step
- setup_mode
- sourcesarray
- scanner_idsarray
- suggestionsarray
- activation_scoutsarray
- automatic_implementationboolean
- implementation_priority
Response
Example request
POST /api /projects /:project_id /signals /onboardingExample response
Status 201
Create signals onboarding complete
Required API key scopes
inbox:writeRequest parameters
- onboarding_origin
- activation_mode
- step
- setup_mode
- sourcesarray
- scanner_idsarray
- suggestionsarray
- activation_scoutsarray
- automatic_implementationboolean
- implementation_priority
Response
Example request
POST /api /projects /:project_id /signals /onboarding /completeExample response
Status 200
Create signals onboarding expose
Required API key scopes
inbox:writeRequest parameters
- onboarding_origin
Response
Example request
POST /api /projects /:project_id /signals /onboarding /exposeExample response
Status 200
List all signals processing
Return current processing state including pause status.
Required API key scopes
inbox:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /signals /processingExample response
Status 200
Delete signals processing pause
View and control signal processing pipeline state for a team.
Required API key scopes
inbox:writeResponse
Example request
DELETE /api /projects /:project_id /signals /processing /pauseExample response
Status 200
List all signals reports
Required API key scopes
inbox:readQuery parameters
- actionabilitystring
- already_addressedboolean
- assigneestringOne of:
"me""mine" - channel_idstring
- connectedstring
- count_onlybooleanDefault:
false - created_afterstring
- created_beforestring
- excludearray
- has_implementation_prboolean
- include_all_statusesboolean
- include_source_metadatabooleanDefault:
true - include_unlistedbooleanDefault:
false - limitinteger
- needs_youboolean
- offsetinteger
- orderingstring
- planstring
- prioritystring
- ranking_idstring
- ranking_min_liftstring
- ranking_min_probabilitystring
- scopestring
- scoutstring
- scout_prefixstring
- searchstring
- sortstring
- source_idstring
- source_productstring
- statusstring
- suggested_reviewersstring
- tagsarray
- task_idstring
- teammate_uuidstring
- unclaimedboolean
- unreadboolean
- use_priority_preferenceboolean
- viewstring
Response
Example request
GET /api /projects /:project_id /signals /reportsExample response
Status 200
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:writeRequest parameters
- titlestring
- summarystring
- evidencearray
- actionability_explanationstring
- actionability
- already_addressedbooleanDefault:
false - repositorystring | null
- priority
- priority_explanationstring | null
- suggested_reviewersarray
- chartsarray
- metricsarray
- suggested_promptsarray
- linksarray
- source_issuesarray
- tagsarray
- idempotency_keystring | null
Response
Example request
POST /api /projects /:project_id /signals /reportsExample response
Status 200 Nothing new was filed: a retry returned the first report (`idempotent_replay` true).
Status 201 Report filed: READY, PENDING_INPUT, or suppressed by the safety judge.
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:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /signals /reports /:id




