Skip to content
Governance Platform

List project-scoped indicators

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

Lists active indicator templates owned by a project, filtered by search and tag, with pagination

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
string

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

Query Parameters

Section titled “Query Parameters ”
search
string

Search by name or description

tag
string

Filter by tag

limit
integer

Page size

offset
integer

Page offset

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Page of project indicator templates

Media type application/json

A page of project indicator templates, with the total available for pagination

object
indicators
Array<object>

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
limit
integer
offset
integer
total
integer
Example 
{
  "indicators": [
    {
      "declarationProfile": {
        "emitOn": "pass"
      },
      "triggerType": "event",
      "type": "custom"
    }
  ]
}

400

Section titled “400 ”

Bad request - Invalid limit or offset 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

Section titled “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

Section titled “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

Section titled “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"
}