API - Indicator Options

Indicator Options

The indicator_options endpoint returns a list of available selectors for the system’s indicators. These selectors are used to filter indicators by specific criteria and depend on the project’s configuration.

Endpoints

get/api/v3/workflow/indicator_options

Return a paginated list of workflow/indicators/options

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
project_id?: unknown
indicator_name?: unknown
value?: unknown
indicator_name?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    project_id?: any;
    indicator_name?: any;
    value?: any;
    indicator_name?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: integer
indicator_name?: string
value?: string
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: { id?: number; indicator_name?: string; value?: string };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};