EQTY LabDocs

Create project-scoped indicator

Creates an immutable indicator template owned by a project and returns the created template

posthttps://localhost:10001/api/v2/projects/{projectId}/indicators
bash
curl --request POST \
  --url 'https://localhost:10001/api/v2/projects/{projectId}/indicators' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"criteria":[{}],"declarationProfile":{"emitOn":{},"statementTemplate":"string","titleTemplate":"string"},"description":"string","extractionRules":{},"name":"string","parameters":{},"provider":"string","slug":"string","tags":["string"],"triggerType":{},"type":{}}'
javascript
const response = await fetch("https://localhost:10001/api/v2/projects/{projectId}/indicators", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "criteria": [
      {}
    ],
    "declarationProfile": {
      "emitOn": {},
      "statementTemplate": "string",
      "titleTemplate": "string"
    },
    "description": "string",
    "extractionRules": {},
    "name": "string",
    "parameters": {},
    "provider": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "triggerType": {},
    "type": {}
  })
});

const data = await response.json();
typescript
interface ProjectIndicatorResponse {
  createdAt?: string;
  criteria?: Record<string, unknown>[];
  declarationProfile?: Record<string, unknown>;
  description?: string;
  extractionRules?: Record<string, unknown>;
  id?: string;
  name?: string;
  parameters?: Record<string, unknown>;
  projectId?: number;
  provider?: string;
  slug?: string;
  tags?: string[];
  triggerType?: "event";
  type?: "custom";
  updatedAt?: string;
  usageCount?: number;
}

const response = await fetch("https://localhost:10001/api/v2/projects/{projectId}/indicators", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "criteria": [
      {}
    ],
    "declarationProfile": {
      "emitOn": {},
      "statementTemplate": "string",
      "titleTemplate": "string"
    },
    "description": "string",
    "extractionRules": {},
    "name": "string",
    "parameters": {},
    "provider": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "triggerType": {},
    "type": {}
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

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

response = requests.post(
    "https://localhost:10001/api/v2/projects/{projectId}/indicators",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "criteria": [
            {},
        ],
        "declarationProfile": {
            "emitOn": {},
            "statementTemplate": "string",
            "titleTemplate": "string",
        },
        "description": "string",
        "extractionRules": {},
        "name": "string",
        "parameters": {},
        "provider": "string",
        "slug": "string",
        "tags": [
            "string",
        ],
        "triggerType": {},
        "type": {},
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	body := strings.NewReader(`{
	  "criteria": [
	    {}
	  ],
	  "declarationProfile": {
	    "emitOn": {},
	    "statementTemplate": "string",
	    "titleTemplate": "string"
	  },
	  "description": "string",
	  "extractionRules": {},
	  "name": "string",
	  "parameters": {},
	  "provider": "string",
	  "slug": "string",
	  "tags": [
	    "string"
	  ],
	  "triggerType": {},
	  "type": {}
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://localhost:10001/api/v2/projects/{projectId}/indicators", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	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>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "criteria": [
                    {}
                  ],
                  "declarationProfile": {
                    "emitOn": {},
                    "statementTemplate": "string",
                    "titleTemplate": "string"
                  },
                  "description": "string",
                  "extractionRules": {},
                  "name": "string",
                  "parameters": {},
                  "provider": "string",
                  "slug": "string",
                  "tags": [
                    "string"
                  ],
                  "triggerType": {},
                  "type": {}
                }
                """))
            .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 System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:10001/api/v2/projects/{projectId}/indicators");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "criteria": [
        {}
      ],
      "declarationProfile": {
        "emitOn": {},
        "statementTemplate": "string",
        "titleTemplate": "string"
      },
      "description": "string",
      "extractionRules": {},
      "name": "string",
      "parameters": {},
      "provider": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "triggerType": {},
      "type": {}
    }
    """, Encoding.UTF8, "application/json");

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 => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "criteria": [
        {}
      ],
      "declarationProfile": {
        "emitOn": {},
        "statementTemplate": "string",
        "titleTemplate": "string"
      },
      "description": "string",
      "extractionRules": {},
      "name": "string",
      "parameters": {},
      "provider": "string",
      "slug": "string",
      "tags": [
        "string"
      ],
      "triggerType": {},
      "type": {}
    }
    JSON,
    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::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "criteria": [
      {}
    ],
    "declarationProfile": {
      "emitOn": {},
      "statementTemplate": "string",
      "titleTemplate": "string"
    },
    "description": "string",
    "extractionRules": {},
    "name": "string",
    "parameters": {},
    "provider": "string",
    "slug": "string",
    "tags": [
      "string"
    ],
    "triggerType": {},
    "type": {}
  }
JSON

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 (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .post("https://localhost:10001/api/v2/projects/{projectId}/indicators")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "criteria": [
                {}
            ],
            "declarationProfile": {
                "emitOn": {},
                "statementTemplate": "string",
                "titleTemplate": "string"
            },
            "description": "string",
            "extractionRules": {},
            "name": "string",
            "parameters": {},
            "provider": "string",
            "slug": "string",
            "tags": [
                "string"
            ],
            "triggerType": {},
            "type": {}
        }))
        .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

Request bodyrequired

Project indicator creation request

application/json
  • criteriaobject[]
  • declarationProfilecore.DeclarationProfilerequired
    Show core.DeclarationProfile
    • emitOnobjectrequired

      When to emit a declaration

      Show properties

      object — When to emit a declaration

    • statementTemplatestring
    • titleTemplatestring
  • descriptionstring
  • extractionRulesobject
  • namestringrequired
  • parametersobject
  • providerstring
  • slugstring

    Slugified; derived from name

  • tagsstring[]
  • triggerTypeobject

    Defaults to event

    Show properties

    object — Defaults to event

  • typeobject

    Defaults to custom, the only accepted value

    Show properties

    object — Defaults to custom, the only accepted value

Examplejson
{
  "criteria": [
    {}
  ],
  "declarationProfile": {
    "emitOn": {},
    "statementTemplate": "string",
    "titleTemplate": "string"
  },
  "description": "string",
  "extractionRules": {},
  "name": "string",
  "parameters": {},
  "provider": "string",
  "slug": "string",
  "tags": [
    "string"
  ],
  "triggerType": {},
  "type": {}
}

Responses

201Created project indicator template

application/json
  • 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
Examplejson
{
  "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
}

400Bad request - Invalid request body or indicator fields

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

404Project not found

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

409Indicator with the same slug already exists

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

500Internal server error

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