Get the latest apply outcome for a quality profile

GET

/goals/apply/status

const url = 'https://example.com/api/v1/goals/apply/status?databaseId=1&profileName=example&arrType=radarr';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/goals/apply/status?databaseId=1&profileName=example&arrType=radarr'

Returns the most recent apply-journal outcome for a profile target, or null if none has been attempted. Out-of-band recovery surface that reports a failed or pending apply even when it never wrote a binding (which the binding endpoint cannot surface) — issue #236.

Parameters

Query Parameters

databaseId

required

integer

profileName

required

string

arrType

required

string

Allowed values: radarr sonarr lidarr

Responses

200

The latest apply status, or null

application/json

object

applyStatus

required

One of:

object
null

Durable outcome of a Quality Goals apply/reconcile attempt (issue #236). Reports whether scoring changed, the binding’s terminal state, and the safe recovery action, so a partial write is never unreported.

object

applyId

required

integer

status

required

string

Allowed values: pending succeeded failed

scoringChanged

required

Whether the scoring ops reached (or may have reached) their intended terminal state.

boolean

bindingStatus

required

string

Allowed values: written pending failed

failureStage

One of:

string
null

string

failureReason

One of:

string
null

string

intentFingerprint

string

startedAt

required

string

settledAt

One of:

string
null

string

recovery

required

The safe operator recovery action for a failed or pending Quality Goals apply (issue #236).

object

action

required

string

Allowed values: none reconcile

endpoint

One of:

string
null

string

Example

{
  "applyStatus": {
    "status": "pending",
    "bindingStatus": "written",
    "recovery": {
      "action": "none"
    }
  }
}

400

Invalid query parameters

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}