Skip to content

List synthesis runs

GET
/signals/{signalId}/synthesis-runs

List synthesis runs that used this signal as input for generating improvements.

signalId
required

Unique identifier for the signal

string

Unique identifier for the signal

statuses

Comma-separated list of statuses to filter by (pending, generating, generated, approved, rejected, failed)

Array<string>
Allowed values: pending generating generated approved rejected failed

Comma-separated list of statuses to filter by (pending, generating, generated, approved, rejected, failed)

page

Page number for pagination (1-indexed)

number
>= 1

Page number for pagination (1-indexed)

pageSize

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

number
>= 1 <= 100

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

orderBy

Field to sort by (default: createdAt)

string
Allowed values: createdAt status

Field to sort by (default: createdAt)

orderDirection

Sort direction: ascending or descending (default: desc)

string
Allowed values: asc desc

Sort direction: ascending or descending (default: desc)

Synthesis runs retrieved successfully

object
synthesisRuns
required

Array of synthesis runs

Array<object>
object
synthesisRunId
required

Unique identifier for the synthesis run

string
pipelineId
required

ID of the pipeline being synthesized

string
pipelineName
required

Name of the pipeline

string
status
required

Synthesis run status

string
Allowed values: pending generating generated approved rejected failed
createdAt
required

ISO 8601 timestamp when the run was created

string format: date-time
completedAt
required

ISO 8601 timestamp when the run completed

string format: date-time
nullable
total
required

Total number of synthesis runs (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

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean