GET /api/optimisation/runs

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

Parameter	Location	Type and requirement
`status`	query	string · optional
`experimentKey`	query	string · optional
`limit`	query	string · optional
`scope`	query	string · optional
`cursor`	query	string · optional

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)

curl --include \
  --request GET \
  'https://api.weavers.app/api/optimisation/runs' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "items": [],
  "nextCursor": null
}

View response model

items required · array of object

View items model

Array items:

runId required · string

experimentName optional · null | string

View experimentName model

Variant 1: null

null

Variant 2: string

string

eurekaStrategyWorkspaceId optional · string

candidate optional · object

View candidate model

id required · string

title required · string

nicheId required · null | number

View nicheId model

Variant 1: null

null

Variant 2: number

number

nicheName required · null | string

View nicheName model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

runNumber optional · null | number

View runNumber model

Variant 1: null

null

Variant 2: number

number

method optional · null | object

View method model

Variant 1: null

null

Variant 2: object

strategyLabel required · string

purpose required · string

task required · string

algorithm required · null | object

View algorithm model

Variant 1: null

null

Variant 2: object

id required · string

label required · string

family required · string

Additional fields: JSON values.

componentVersion required · null | string

View componentVersion model

Variant 1: null

null

Variant 2: string

string

algorithmSource required · "unavailable" | "configured" | "recorded"

Additional fields: JSON values.

experimentKey required · "tp_sl_two_stage"

templateKey required · "tp_sl_two_stage_nsga2_v1"

visibility required · "private" | "community"

publishedAt required · null | string

View publishedAt model

Variant 1: null

null

Variant 2: string

string

cluster required · "dev"

workerCount required · number

workersRunning required · number

workersSucceeded required · number

workersFailed required · number

workersPending required · number

createdAt required · string

startedAt required · null | string

View startedAt model

Variant 1: null

null

Variant 2: string

string

finishedAt required · null | string

View finishedAt model

Variant 1: null

null

Variant 2: string

string

cancelledAt required · null | string

View cancelledAt model

Variant 1: null

null

Variant 2: string

string

requestedByEmail required · null | string

View requestedByEmail model

Variant 1: null

null

Variant 2: string

string

ingestedRows optional · null | number

View ingestedRows model

Variant 1: null

null

Variant 2: number

number

rowProgress optional · null | object

View rowProgress model

Variant 1: null

null

Variant 2: object

phase required · null | string

View phase model

Variant 1: null

null

Variant 2: string

string

status required · null | string

View status model

Variant 1: null

null

Variant 2: string

string

message required · null | string

View message model

Variant 1: null

null

Variant 2: string

string

updatedAt required · null | string

View updatedAt model

Variant 1: null

null

Variant 2: string

string

workerKey required · null | string

View workerKey model

Variant 1: null

null

Variant 2: string

string

rawRows required · null | number

View rawRows model

Variant 1: null

null

Variant 2: number

number

selectedRows required · null | number

View selectedRows model

Variant 1: null

null

Variant 2: number

number

stageBInputRows required · null | number

View stageBInputRows model

Variant 1: null

null

Variant 2: number

number

preHoldoutRows required · null | number

View preHoldoutRows model

Variant 1: null

null

Variant 2: number

number

holdoutRows required · null | number

View holdoutRows model

Variant 1: null

null

Variant 2: number

number

stageBSignalRows required · null | number

View stageBSignalRows model

Variant 1: null

null

Variant 2: number

number

stageBTrialRows required · null | number

View stageBTrialRows model

Variant 1: null

null

Variant 2: number

number

stageAFinalRows required · null | number

View stageAFinalRows model

Variant 1: null

null

Variant 2: number

number

stageA2ScoredRows required · null | number

View stageA2ScoredRows model

Variant 1: null

null

Variant 2: number

number

symbolCount required · null | number

View symbolCount model

Variant 1: null

null

Variant 2: number

number

dayCount required · null | number

View dayCount model

Variant 1: null

null

Variant 2: number

number

Additional fields: JSON values.

nextCursor required · null | string

View nextCursor model

Variant 1: null

null

Variant 2: string

string

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

default · Operation-specific error. Inspect error/code before deciding whether to retry.

application/json

default example · synthetic data

{
  "error": "example",
  "code": "example"
}

View response model

error required · string

code required · string

Additional fields: JSON values.