EQTY LabDocs

List project-scoped indicators

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

gethttps://localhost:10001/api/v2/projects/{projectId}/indicators
bash
curl --request GET \
  --url 'https://localhost:10001/api/v2/projects/{projectId}/indicators' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:10001/api/v2/projects/{projectId}/indicators", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface ProjectIndicatorListResponse {
  indicators?: Record<string, unknown>[];
  limit?: number;
  offset?: number;
  total?: number;
}

const response = await fetch("https://localhost:10001/api/v2/projects/{projectId}/indicators", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: ProjectIndicatorListResponse = await response.json();
python
import requests

response = requests.get(
    "https://localhost:10001/api/v2/projects/{projectId}/indicators",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v2/projects/{projectId}/indicators", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:10001/api/v2/projects/{projectId}/indicators"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v2/projects/{projectId}/indicators");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:10001/api/v2/projects/{projectId}/indicators');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:10001/api/v2/projects/{projectId}/indicators")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:10001/api/v2/projects/{projectId}/indicators")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Parameters

Path parameters

NameTypeDescription
projectId
required
string

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

Query parameters

NameTypeDescription
searchstring

Search by name or description

tagstring

Filter by tag

limitinteger

Page size

offsetinteger

Page offset

Responses

200Page of project indicator templates

application/json
  • indicatorshandlers.ProjectIndicatorResponse[]
    Show properties

    Array of handlers.ProjectIndicatorResponse

    • createdAtstring<date-time>
    • criteriaobject[]
    • declarationProfilecore.DeclarationProfile
      Show core.DeclarationProfile
      • emitOnobjectrequired

        When to emit a declaration

        Show properties

        object — When to emit a declaration

      • statementTemplatestring
      • titleTemplatestring
    • descriptionstring
    • extractionRulesobject
    • idstring

      urn:uuid form

    • namestring
    • parametersobject
    • projectIdinteger
    • providerstring
    • slugstring
    • tagsstring[]
    • triggerTypecore.TriggerType

      One ofevent

    • typecore.IndicatorType

      One ofcustom

    • updatedAtstring<date-time>
    • usageCountinteger
  • limitinteger
  • offsetinteger
  • totalinteger
Examplejson
{
  "indicators": [
    {
      "createdAt": "2025-01-01T00:00:00Z",
      "criteria": [
        {}
      ],
      "declarationProfile": {
        "emitOn": {},
        "statementTemplate": "string",
        "titleTemplate": "string"
      },
      "description": "string",
      "extractionRules": {},
      "id": "string",
      "name": "string",
      "parameters": {},
      "projectId": 0,
      "provider": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "triggerType": "event",
      "type": "custom",
      "updatedAt": "2025-01-01T00:00:00Z",
      "usageCount": 0
    }
  ],
  "limit": 0,
  "offset": 0,
  "total": 0
}

400Bad request - Invalid limit or offset parameter

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

403Forbidden - No project access or insufficient permissions

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

500Internal server error

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}