List enriched project indicator applications

GET

/api/v2/projects/{projectId}/indicator-applications

curl --request GET \
  --url https://localhost:10001/api/v2/projects/example/indicator-applications \
  --header 'Authorization: <Authorization>'

Lists project indicator applications with template, policy/control context, and latest evaluation, filtered and paginated

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

string

Project ID, UUID (urn:uuid optional), or slug:my-project

Query Parameters

indicatorId

string

Indicator UUID

appliedPolicyId

string

Applied policy ID, slug:my-policy, or urn:cid:bafy…

appliedPolicyControlId

integer

Applied policy control ID

applicationUuid

string

Application UUID

status

string

Application status

includeArchived

boolean

Include archived applications

limit

integer

Page size

offset

integer

Page offset

Responses

200

Page of enriched indicator applications

Media type application/json

The expanded indicator applications matching the request, unpaginated

object

applications

Array<object>

An indicator application expanded with its template and the control it is applied to

object

applicationUuid

Urn:uuid form

string

appliedPolicyControlId

integer

appliedPolicyId

integer

appliedPolicyName

string

appliedPolicySlug

string

controlCode

string

controlId

integer

controlTitle

string

createdAt

string format: date-time

id

integer

indicator

A project-scoped indicator template, with a count of the controls it is applied to

object

createdAt

string format: date-time

criteria

Array<object>

object

declarationProfile

object

emitOn

required

When to emit a declaration

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

description

string

extractionRules

object

id

Urn:uuid form

string

name

string

parameters

object

projectId

integer

provider

string

slug

string

tags

Array<string>

triggerType

string

Allowed values: event

type

string

Allowed values: custom

updatedAt

string format: date-time

usageCount

integer

indicatorId

Urn:uuid form

string

lastEvaluatedAt

string format: date-time

latestEvaluation

One indicator evaluation, including its criteria outcomes and any declaration it produced

object

applicationId

integer

createdAt

string format: date-time

criterionResults

Array<object>

One criterion’s outcome within an evaluation; the evaluation passes only when every criterion does

object

criteriaIndex

integer

field

string

reason

string

status

string

Allowed values: pass fail skipped

declarationIds

Array<integer>

durationMs

Evaluation wall time in milliseconds

integer

evaluatedAt

string format: date-time

extractedFields

object

failureDetails

Array<object>

The machine-readable reason a criterion failed, including the values compared

object

actualValue

arrayMatchMode

string

Allowed values: all any

criteriaIndex

integer

criteriaType

string

Allowed values: string number boolean date list[string] list[number]

elementPath

string

expectedValue

extractionPath

string

field

string

indexPath

Array<integer>

missing

boolean

operator

string

Allowed values: eq neq gt lt gte lte in notIn contains notContains

reason

string

failureReasons

Array<string>

id

Urn:uuid form

string

indicatorId

Urn:uuid form

string

result

string

Allowed values: pass fail error awaiting_evaluation

triggerSource

string

projectId

integer

status

string

Allowed values: active disabled archived

updatedAt

string format: date-time

limit

integer

offset

integer

total

integer

Example

{
  "applications": [
    {
      "indicator": {
        "declarationProfile": {
          "emitOn": "pass"
        },
        "triggerType": "event",
        "type": "custom"
      },
      "latestEvaluation": {
        "criterionResults": [
          {
            "status": "pass"
          }
        ],
        "failureDetails": [
          {
            "arrayMatchMode": "all",
            "criteriaType": "string",
            "operator": "eq"
          }
        ],
        "result": "pass"
      },
      "status": "active"
    }
  ]
}

400

Bad request - Invalid query filter parameter

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - No project access or insufficient permissions

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

Media type application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}