Skip to content
Anlyon
Esc
↑↓navigate↵open⌘Jpreview

List governed effects

Effects are the business operations governed actions perform: one per operation, however many attempts it took. A governed action is one with an adapter or one that carries a declaration. Each effect carries its execution stage, its business outcome (pending, succeeded, failed, unknown), whether a failure may have had partial impact, who established the outcome (verification: the provider’s evidence, an operator’s manual resolution, or nobody yet), and its receipt grade. Filter by unresolved=true for everything still holding impact-limit capacity, or by grade.

GET/api/v2/actions/effects
Authorization
AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

or
better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters
actionstring

Filter by action name.

min length 1 · max length 100
outcomestring
Allowed:not_dispatchedpendingsucceededfailedunknown
stagestring
Allowed:awaiting_approvalreadydispatchingreconcilingsettledrejected
gradestring

Filter by receipt grade.

Allowed:confirmedacknowledgedunknownfailedrefuseddeniedpending
unresolvedstring

Only effects that are pending, unknown, or possibly partial.

Allowed:truefalse
limitinteger
min 1 · max 100 · default: 20
offsetinteger
min 0 · default: 0
Header parameters
X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128
Responses
200

Effects returned.

successbooleanrequired
Allowed:true
dataEffect[]required
Show properties
Array of Effect
idstringrequired
invocationIdstringrequired
operationKeystringrequired
environmentIdstring<uuid>required
actionobjectrequired
Show properties
namestringrequired
versionIdstringrequired
adapterobjectrequired
Show properties
typestringrequired
versionstringrequired
stagestringrequired
Allowed:awaiting_approvalreadydispatchingreconcilingsettledrejected
outcomestringrequired
Allowed:not_dispatchedpendingsucceededfailedunknown
partialEffectstringrequired

A failure is not proof of zero impact.

Allowed:nonepossibleconfirmed
gradestringrequired

The receipt grade, derived by the database from the stage, outcome, outcome source and rejection reason. confirmed: the outcome is succeeded and it was read from the provider's own record of the operation, or a declared read-back matched. acknowledged: the provider accepted the request with a 2xx and no read-back has matched. An operator's manual succeeded also grades here and keeps verification: manual. unknown: no usable response, so reconciliation owns the effect and its allowance stays held. failed: the provider rejected the request, or the request provably never left Anlyon. refused: Anlyon refused at dispatch, for example on a digest mismatch, an exhausted or unbounded limit, an expired preview or a changed action version. denied: the approval was denied. pending: no receipt yet.

Allowed:confirmedacknowledgedunknownfailedrefuseddeniedpending
verificationstringrequired
Allowed:providermanualunverifiednot_dispatched
providerReferencestring | nullrequired
targetobjectrequired
impactImpactQuantity[]required
Show properties
Array of ImpactQuantity
dimensionstringrequired

money, resource_mutations, or a workspace-declared unit such as emails.

matches ^[a-z][a-z0-9_]{0,31}$
currencystring

Present for money.

matches ^[a-z]{3}$
amountintegerrequired

Integer minor units for money. A count for every other dimension.

min 0
boundstringrequired
Allowed:exactupper_bound
previewIdstring | nullrequired
approvalIdstring | nullrequired
bindingDigeststring | nullrequired
dependsOnobject[]required
Show properties
Array of object
effectIdstringrequired
outcomestringrequired
compensatesstring | nullrequired
rejectionReasonstring | nullrequired
unresolvedExposurebooleanrequired
reconciliationobjectrequired
Show properties
attemptsintegerrequired
min 0
nextAtstring<date-time> | nullrequired
exhaustedbooleanrequired
createdAtstring<date-time>required
firstDispatchedAtstring<date-time> | nullrequired
outcomeAtstring<date-time> | nullrequired
updatedAtstring<date-time>required
paginationOffsetPaginationrequired
Show properties
totalintegerrequired
min 0
pageintegerrequired
min 1
limitintegerrequired
min 1
totalPagesintegerrequired
min 0
hasMorebooleanrequired
400

Bad Request - Invalid input data

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
401

Unauthorized - Invalid or missing API key

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
429

Too Many Requests - Rate limit exceeded

successbooleanrequired
requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired
Show properties
codestring
messagestring
detailsobject
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.anlyon.com/api/v2/actions/effects' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "success": true,
  "data": [
    {
      "id": "eff_01JABCDEF",
      "invocationId": "string",
      "operationKey": "string",
      "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
      "action": {
        "name": "string",
        "versionId": "string"
      },
      "adapter": {
        "type": "string",
        "version": "string"
      },
      "stage": "awaiting_approval",
      "outcome": "not_dispatched",
      "partialEffect": "none",
      "grade": "confirmed",
      "verification": "provider",
      "providerReference": "string",
      "target": {},
      "impact": [
        {
          "dimension": "money",
          "currency": "usd",
          "amount": 0,
          "bound": "exact"
        }
      ],
      "previewId": "string",
      "approvalId": "string",
      "bindingDigest": "string",
      "dependsOn": [
        {
          "effectId": "string",
          "outcome": "string"
        }
      ],
      "compensates": "string",
      "rejectionReason": "string",
      "unresolvedExposure": true,
      "reconciliation": {
        "attempts": 0,
        "nextAt": "2019-08-24T14:15:22Z",
        "exhausted": true
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "firstDispatchedAt": "2019-08-24T14:15:22Z",
      "outcomeAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "total": 0,
    "page": 1,
    "limit": 1,
    "totalPages": 0,
    "hasMore": true
  }
}