Get project-scoped indicator

GET

/api/v2/projects/{projectId}/indicators/{indicatorId}

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

Retrieves one project-owned indicator template by UUID along with its usage count

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

integer

Project ID

indicatorId

required

string

Indicator UUID

Responses

200

Project indicator template

Media type application/json

object

createdAt

string

criteria

Array<object>

object

declarationProfile

object

emitOn

“pass” | “fail” | “both” | “none”

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

description

string

extractionRules

object

id

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

usageCount

integer

Example

{
  "declarationProfile": {
    "emitOn": "pass"
  },
  "triggerType": "event",
  "type": "custom"
}

400

Bad request - Invalid indicator ID format

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

401

Unauthorized - Authentication required

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

403

Forbidden - No project access or insufficient permissions

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

404

Indicator not found

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

500

Internal server error

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}