Skip to content

List signals

GET
/signals

List signals with optional filtering by team, data type, or linked executions.

signalIds

Comma-separated list of signal IDs to filter by

string
nullable

Comma-separated list of signal IDs to filter by

teamIds

Comma-separated list of team IDs to filter by

string
nullable

Comma-separated list of team IDs to filter by

executionIds

Comma-separated list of pipeline execution IDs to filter by

string
nullable

Comma-separated list of pipeline execution IDs to filter by

dataTypes

Comma-separated list of data types to filter by (comment, rating, evaluation)

string
nullable

Comma-separated list of data types to filter by (comment, rating, evaluation)

page

Page number for pagination (1-indexed)

number
>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 50)

number
>= 1 <= 100

Number of results per page (1-100, default: 50)

orderDirection

Sort direction: ascending or descending (default: desc)

string
Allowed values: asc desc

Sort direction: ascending or descending (default: desc)

Signals retrieved successfully

object
signals
required

Array of signals matching the query

Array<object>
object
signalId
required

Unique identifier for the signal (nanoid format)

string
teamId
required

ID of the team that owns this signal

string
dataType
required

Type of signal data

string
Allowed values: comment rating evaluation
data
required
One of:
object
type
required

Signal type identifier

string
Allowed values: comment
text
required

The comment text content

string
>= 1 characters
executionIds
required

IDs of pipeline executions this signal is linked to

Array<string>
createdAt
required

ISO 8601 timestamp when the signal was created

string format: date-time
total
required

Total number of signals matching the query (before pagination)

number
page
required

Current page number

number
pageSize
required

Number of results per page

number

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean