API - Indicators

Indicators

No description given.

Endpoints

get/api/v3/workflow/projects/:project_id/indicators/:key/:period

Summary

Retrieves data points for the specified indicator key within a given date range and project. You can choose whether to return accumulated or mean values, specify the time period granularity (day, week, month, or quarter), and optionally provide a selector if the indicator provide it.

from and to parameters

The from and to parameters define the inclusive date range.

If the date range is not a multiple of the period, the last period will extended. For example, if the period is week and the date range is from 2020-01-01 to 2020-01-15, the last week will be extended to 2020-01-19.

The number of period between from and to should be less than 1000.

To get a summary of existing keys and selectors, you can use the GET /projects/:project_id/indicators endpoint.

Input Schema

object
project_id: integer
The indicator key to get the data for
key: string
The time period to get the data for
period: string
The selector to get the data for
selector?: string or null
The account id to get the data for. Let it `nil` for full team data
account_id?: integer or null
The start date to get the data for (included)
from: date
The end date to get the data for (included)
to: date

Typescript

type InputSchema = {
  project_id: number;
  // The indicator key to get the data for
  key: string;
  // The time period to get the data for
  period: string;
  // The selector to get the data for
  selector?: string | null;
  // The account id to get the data for. Let it `nil` for full team data
  account_id?: number | null;
  // The start date to get the data for (included)
  from: Date;
  // The end date to get the data for (included)
  to: Date;
};