Get project-scoped indicator

GET

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

const url = 'https://localhost:10001/api/v2/projects/example/indicators/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

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://localhost:10001/api/v2/projects/example/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

string

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

indicatorId

required

string

Indicator UUID (urn:uuid optional) or slug:my-indicator

Responses

200

Project indicator template

application/json

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

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

Example

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

400

Bad request - Invalid indicator ID format

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

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

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"
}

404

Indicator not found

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

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"
}