Signals
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
POST | |
GET | |
GET | |
GET | |
POST | |
GET |
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 configs filter catalogs
List the sources whose filter this project can set, each with the fields a filter expression can use and example expressions. A filter is a boolean expression saved in a source config's config.hogql_filter. It excludes records before any AI processing. Available before the source is connected or synced.
Required API key scopes
inbox:readResponse
Example request
GET /api /projects /:project_id /signals /source_configs /filter_catalogsExample response
Status 200
Create signals source configs filter preview
Check a filter expression before saving it, and see what it does to the source's records created in the last 7 days: how many pass and how many it excludes, with the newest of each. Reads the records emission would read, with the source's saved team allowlist, and runs with your own warehouse access. Records that pass can still be skipped later by guidance or deduplication. Saves nothing and calls no AI.
Required API key scopes
inbox:readquery:readRequest parameters
- source_productstring
- source_typestring
- expressionstring
Response
Example request
POST /api /projects /:project_id /signals /source_configs /filter_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




