Body

Media type: application/json

Type: object

• application: required(string)

  Application name.

• timestampColumn: (string)

  Elastic timestamp column name to search.

• from: required(string)

  Specify the start of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

• to: required(string)

  Specify the end of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

• dimensions: required(array of table.DimensionColumn)

  List of columns that going to be used as group by queries dimensions.

  Items: DimensionColumn

  • name: (string)

    Column display name. Path defaults to column name if not provided.

  • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

    Origin from which this column will be queried.

  • path: required(string)

    Path for the target metric in the datasource.

  • type: required(one of STRING, NUMBER, DATE, BOOL)

    Expected column type

  • expression: (string)

    A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

    Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

    Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

    Example:

    {{column}} km/h
    {{#dateTime}}{{column}}{{/dateTime}}
    {{#dateOnly}}{{column}}{{/dateOnly}}
    {{#timeOnly}}{{column}}{{/timeOnly}}
    {{#round}}{{column}}{{/round}}
    {{#round1}}{{column}}{{/round1}}
    {{#round2}}{{column}}{{/round2}}
    {{#iff}}{{column}}|Active|Inactive{{/iff}}
    

  • orderIndex: (number)

    Specifies the sequence or position of the column in the table.

  • defaultValue: (any)

    Value substituted when the dimension's source value is absent, null, or empty string. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

  • useDefaultValue: (boolean)

    When true, missing/null/empty dimension values are replaced with defaultValue. Defaults to false (existing behaviour preserved).

• columns: required(array of table.AggregationColumn)

  Specifies the aggregation columns.

  Items: AggregationColumn

  • name: (string)

    Column display name. Path defaults to column name if not provided.

  • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

    Origin from which this column will be queried.

  • path: required(string)

    Path for the target metric in the datasource.

  • type: required(one of STRING, NUMBER, DATE, BOOL)

    Expected column type.

  • function: required(one of SUM, AVG, MIN, MAX, COUNT, LAST)

    Aggregation function to be applied.

  • expression: (string)

    A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

    Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

    Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

    Example:

    {{column}} km/h
    {{#dateTime}}{{column}}{{/dateTime}}
    {{#dateOnly}}{{column}}{{/dateOnly}}
    {{#timeOnly}}{{column}}{{/timeOnly}}
    {{#round}}{{column}}{{/round}}
    {{#round1}}{{column}}{{/round1}}
    {{#round2}}{{column}}{{/round2}}
    {{#iff}}{{column}}|Active|Inactive{{/iff}}
    

  • orderIndex: (number)

    Specifies the sequence or position of the column in the table.

  • defaultValue: (any)

    Value substituted when the aggregation result is absent or null. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

  • useDefaultValue: (boolean)

    When true, null/absent aggregation results are replaced with defaultValue. Additionally, when at least one aggregation column has this enabled, rows are created for dimension members (e.g. from metadata) that have no analytics data, with aggregation columns filled from their configured defaults. Defaults to false (existing behaviour preserved).

• timeDimension: required(array of table.TimeHistDimensionColumn)

  Time histogram component of the group by queries dimensions.

  Items: TimeHistDimensionColumn

  • name: (string)

    Column display name. Path defaults to column name if not provided.

  • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

    Origin from which this column will be queried.

  • path: required(string)

    Path for the target metric in the datasource.

  • type: required(one of STRING, NUMBER, DATE, BOOL)

    Expected column type.

  • calendarInterval: required(string)

    Calendar interval passed to the elasticsearch.

  • expression: (string)

    A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

    Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

    Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

    Example:

    {{column}} km/h
    {{#dateTime}}{{column}}{{/dateTime}}
    {{#dateOnly}}{{column}}{{/dateOnly}}
    {{#timeOnly}}{{column}}{{/timeOnly}}
    {{#round}}{{column}}{{/round}}
    {{#round1}}{{column}}{{/round1}}
    {{#round2}}{{column}}{{/round2}}
    {{#iff}}{{column}}|Active|Inactive{{/iff}}
    

  • orderIndex: (number)

    Specifies the sequence or position of the column in the table.

• where: required(array of table.WhereColumn)

  Filter conditions to be applied to the data.

  Items: WhereColumn

  • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

    Origin from which this column will be queried.

  • path: required(string)

    Path for the target metric in the datasource.

  • type: required(one of STRING, NUMBER, DATE, BOOL)

    Column type.

  • function: required(one of EQ, IN, LAST, IN_RANGE)

    Filter function to be applied.

  • value: required(object)

    Value to be applied for filtering.
  • from: required(string)

    Used for filtering in the IN_RANGE function.

  • to: required(string)

    Used for filtering in the IN_RANGE function.

Example:

{
  "dimensions": [
    {
      "source": "ANALYTICS",
      "name": "Device ID",
      "path": "endpointId.keyword",
      "type": "STRING"
    },
    {
      "source": "METADATA",
      "name": "Vehicle name",
      "path": "name",
      "type": "STRING",
      "useDefaultValue": true,
      "defaultValue": "unknown"
    },
    {
      "source": "ASSET",
      "name": "Vehicle brand",
      "path": "dataSample.relations.IS_CONTAINED_BY.entityId.asset_tp_f8bc6ed6:brand",
      "type": "STRING"
    }
  ],
  "columns": [
    {
      "source": "ANALYTICS",
      "name": "Average speed",
      "path": "dataSample.speed",
      "type": "NUMBER",
      "function": "AVG",
      "expression": "{{average speed}} km/h",
      "useDefaultValue": true,
      "defaultValue": 0
    }
  ],
  "where": [
    {
      "source": "METADATA",
      "path": "connected",
      "type": "BOOL",
      "function": "EQ",
      "value": true
    }
  ],
  "application": "cnc5h752908c73fp4pd0",
  "from": "now-10h",
  "to": "now"
}

Query Parameters

• application: required(string)

  Application name.

HTTP status code 200

Operations successfully retrieved.

Body

Media type: application/json

Type: object

Example:

{
  "TIME_SERIES": [
    {
      "type": "STRING",
      "allowedStages": [
        "DIMENSION"
      ]
    }
  ],
  "ANALYTICS": [
    {
      "type": "STRING",
      "allowedStages": [
        "DIMENSION",
        "WHEN_CONDITION",
        "AGGREGATION"
      ],
      "aggregationFunctions": [
        "COUNT",
        "LAST"
      ],
      "filterFunctions": [
        "EQ",
        "IN"
      ]
    },
    {
      "type": "NUMBER",
      "allowedStages": [
        "AGGREGATION",
        "DIMENSION",
        "WHEN_CONDITION"
      ],
      "aggregationFunctions": [
        "MIN",
        "AVG",
        "SUM",
        "MAX",
        "COUNT",
        "LAST"
      ],
      "filterFunctions": [
        "EQ",
        "IN"
      ]
    },
    {
      "type": "DATE",
      "allowedStages": [
        "DIMENSION",
        "TIME_DIMENSION",
        "WHEN_CONDITION",
        "AGGREGATION"
      ],
      "aggregationFunctions": [
        "MAX",
        "MIN",
        "COUNT",
        "LAST"
      ],
      "filterFunctions": [
        "IN_RANGE"
      ]
    },
    {
      "type": "BOOL",
      "allowedStages": [
        "DIMENSION",
        "WHEN_CONDITION",
        "AGGREGATION"
      ],
      "aggregationFunctions": [
        "COUNT",
        "LAST"
      ],
      "filterFunctions": [
        "EQ"
      ]
    }
  ],
  "METADATA": [
    {
      "type": "BOOL",
      "allowedStages": [
        "DIMENSION",
        "WHEN_CONDITION"
      ],
      "filterFunctions": [
        "EQ"
      ]
    }
  ]
}

Body

Media type: application/json

Type: object

• name: required(string)

  Template name.

• reportName: (string)

  The name of the report to be generated. If not provided, the template name will be used.

  Can include the following placeholders:

  • "{{createdDate}}"
  • "{{createdDateTime}}"
  • "{{fromDate}}"
  • "{{fromDateTime}}"
  • "{{toDate}}"
  • "{{toDateTime}}"

  Example:

  Report_Name_{{createdDate}}

• executionState: (one of ACTIVE, INACTIVE - default: ACTIVE)

  Represents the state of the template execution. When set to ACTIVE, all triggers associated with the template will be enabled.

• triggers: (array of string)

  IDs of triggers associated with this template. These trigger IDs define when the report should be generated.

• exportType: (one of CSV_IN_ZIP, PDF, EXCEL - default: CSV_IN_ZIP)

  The format of the report in which the notification will be sent.

• exportTemplate: (object)

  Offers customization options to define the layout and content of report exports.

  Placeholders for report data:

  • "${reportName}": The name of the report.
  • "${reportCreatedDate}": The creation date of the report.
  • "${reportCreatedDateTime}": The creation date and time of the report.

  Placeholders for each table:

  • "${table.name}": Table name.
  • "${table.description}": Table description.
  • "${table.application}": Application name.
  • "${table.fromDate}": Start date of the table data.
  • "${table.fromDateTime}": Start date and time of the table data.
  • "${table.toDate}": End date of the table data.
  • "${table.toDateTime}": End date and time of the table data.
  • "${table.headers}": Table headers.
  • "${table.data}": Table data.

  If not provided, a default template will be used.

  • pdfTemplate: (string)

    Content of the FreeMarker template for customizing PDF report exports.

  • csvTemplate: (string)

    Content of the FreeMarker template for customizing CSV report exports.

• emailTemplate: (object)

  Notifies recipients that a report has been generated and is available for download.

  • recipients: (array of string)

    A list of email addresses of the recipients.

  • subject: (string - default: Kaaiot Report)

    The subject line of the email notification.

  • template: (string)

    The HTML content of the email notification. If not provided, a default template will be used.

    Can include the following placeholders:

    • "{{report_download_link}}": Link to download the report.
    • "{{report_name}}": Name of the generated report.
    • "{{year}}": Current year.
• poolIds: (array of string)

  An array of the unique identifiers of the pools to which the template will be attached.

Example:

{
  "name": "Monthly Sensor Readings",
  "reportName": "sensor__readings__{{createdDate}}",
  "exportType": "PDF",
  "executionState": "ACTIVE",
  "triggers": [
    "aa3f7b8d-3a22-46e8-8803-e89480ff73f1"
  ],
  "exportTemplate": {
    "pdfTemplate": "<html><head><table><thead><tr><#list table.headers as header><th>${header}</th></#list></tr></thead></table></#list></body></html>",
    "csvTemplate": "${table.headers?join(\",\")}"
  },
  "emailTemplate": {
    "subject": "Sensor Readings Report",
    "template": "<html><body><p>{{report_name}}</p></body></html>",
    "recipients": [
      "example@kaaiot.io"
    ]
  },
  "poolIds": [
    "aXJuOnJjNzNkYmg3cTA6aWFtY29yZTo0YXRjaWNuaXNnOjpwb29sL2Rldg=="
  ]
}

Query Parameters

• templateId: (array of )

  Template IDs.

• name: (string)

  Template name. Supports partial match.

• executionState: (one of ACTIVE, INACTIVE)

  State of the template execution.

• page: (number - default: 0)

  Page number.

  Example:

  0

• size: (number - default: 100)

  Page size.

  Example:

  10

• sort: (one of createdAt, updatedAt - default: createdAt)

  Field to sort by.

  Example:

  updatedAt

• sortOrder: (one of asc, desc - default: desc)

  Sort direction.

  Example:

  asc

URI Parameters

• templateId: required(string)

  Template ID.

URI Parameters

• templateId: required(string)

  Template ID.

URI Parameters

• templateId: required(string)

  Template ID.

Body

Media type: application/json

Type: object

• name: required(string)

  Report template name.

• reportName: required(string)

  The name of the report to be generated. If not provided, the template name will be used.

  Can include the following placeholders:

  • "{{createdDate}}"
  • "{{createdDateTime}}"
  • "{{fromDate}}"
  • "{{fromDateTime}}"
  • "{{toDate}}"
  • "{{toDateTime}}"

  Example:

  Report_Name_{{createdDate}}

• exportType: required(one of CSV_IN_ZIP, PDF, EXCEL)

  The format of the report in which the notification will be sent.

• exportTemplate: (object)

  Offers customization options to define the layout and content of report exports.

  Placeholders for report data:

  • "${reportName}": The name of the report.
  • "${reportCreatedDate}": The creation date of the report.
  • "${reportCreatedDateTime}": The creation date and time of the report.

  Placeholders for each table:

  • "${table.name}": Table name.
  • "${table.description}": Table description.
  • "${table.application}": Application name.
  • "${table.fromDate}": Start date of the table data.
  • "${table.fromDateTime}": Start date and time of the table data.
  • "${table.toDate}": End date of the table data.
  • "${table.toDateTime}": End date and time of the table data.
  • "${table.headers}": Table headers.
  • "${table.data}": Table data.

  If not provided, a default template will be used.

  • pdfTemplate: (string)

    Content of the FreeMarker template for customizing PDF report exports.

  • csvTemplate: (string)

    Content of the FreeMarker template for customizing CSV report exports.

• emailTemplate: required(object)

  Notifies recipients that a report has been generated and is available for download.

  • recipients: (array of string)

    A list of email addresses of the recipients.

  • subject: (string - default: Kaaiot Report)

    The subject line of the email notification.

  • template: (string)

    The HTML content of the email notification. If not provided, a default template will be used.

    Can include the following placeholders:

    • "{{report_download_link}}": Link to download the report.
    • "{{report_name}}": Name of the generated report.
    • "{{year}}": Current year.

Example:

{
  "name": "Monthly Sensor Readings",
  "reportName": "sensor__readings__{{createdDate}}",
  "exportType": "PDF",
  "exportTemplate": {
    "pdfTemplate": "<html><head><table><thead><tr><#list table.headers as header><th>${header}</th></#list></tr></thead></table></#list></body></html>",
    "csvTemplate": "${table.headers?join(\",\")}"
  },
  "emailTemplate": {
    "subject": "Sensor Readings Report",
    "template": "<html><body><p>{{report_name}}</p></body></html>",
    "recipients": [
      "example@kaaiot.io"
    ]
  }
}

URI Parameters

• templateId: required(string)

  Template ID.

Query Parameters

• type: required(one of ACTIVE, INACTIVE)

  The execution state to set.

URI Parameters

• templateId: required(string)

  Template ID.

Body

Media type: application/json

Type: array of string

Example:

[
  "aa3f7b8d-3a22-46e8-8803-e89480ff73f1"
]

URI Parameters

• templateId: required(string)

  Template ID.

Body

Media type: application/x-www-form-urlencoded

Type: any

URI Parameters

• templateId: required(string)

  Template ID.

URI Parameters

• templateId: required(string)

  Template ID.

Body

Media type: application/json

Type: object

• name: required(string - pattern: ^.{1,30}$)

  Table name.

• description: (string)

  Description and notes for this table.

• orderIndex: (number)

  Specifies the sequence or position of the table in the report.

• query: required(object)

  The query used to retrieve data for the table.

  • application: required(string)

    Application name.

  • timestampColumn: (string)

    Elastic timestamp column name to search.

  • from: required(string)

    Specify the start of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

  • to: required(string)

    Specify the end of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

  • dimensions: required(array of table.DimensionColumn)

    List of columns that going to be used as group by queries dimensions.

    Items: DimensionColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

    • defaultValue: (any)

      Value substituted when the dimension's source value is absent, null, or empty string. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

    • useDefaultValue: (boolean)

      When true, missing/null/empty dimension values are replaced with defaultValue. Defaults to false (existing behaviour preserved).

  • columns: required(array of table.AggregationColumn)

    Specifies the aggregation columns.

    Items: AggregationColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type.

    • function: required(one of SUM, AVG, MIN, MAX, COUNT, LAST)

      Aggregation function to be applied.

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

    • defaultValue: (any)

      Value substituted when the aggregation result is absent or null. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

    • useDefaultValue: (boolean)

      When true, null/absent aggregation results are replaced with defaultValue. Additionally, when at least one aggregation column has this enabled, rows are created for dimension members (e.g. from metadata) that have no analytics data, with aggregation columns filled from their configured defaults. Defaults to false (existing behaviour preserved).

  • timeDimension: required(array of table.TimeHistDimensionColumn)

    Time histogram component of the group by queries dimensions.

    Items: TimeHistDimensionColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type.

    • calendarInterval: required(string)

      Calendar interval passed to the elasticsearch.

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

  • where: required(array of table.WhereColumn)

    Filter conditions to be applied to the data.

    Items: WhereColumn

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Column type.

    • function: required(one of EQ, IN, LAST, IN_RANGE)

      Filter function to be applied.

    • value: required(object)

      Value to be applied for filtering.
    • from: required(string)

      Used for filtering in the IN_RANGE function.

    • to: required(string)

      Used for filtering in the IN_RANGE function.

Example:

{
  "name": "Sensor humidity readings",
  "description": "Sensor FMC-500",
  "query": {
    "dimensions": [
      {
        "source": "METADATA",
        "path": "name",
        "type": "STRING",
        "useDefaultValue": true,
        "defaultValue": "unknown"
      },
      {
        "source": "TIME_SERIES",
        "path": "endpointId",
        "type": "NUMBER"
      },
      {
        "source": "TIME_SERIES",
        "name": "humidity",
        "path": "auto~humidity",
        "type": "NUMBER"
      }
    ],
    "application": "cnc5h752908c73fp4pd0",
    "from": "now-1h",
    "to": "now"
  }
}

URI Parameters

• templateId: required(string)

  Template ID.

• tableId: required(string)

  Table ID.

Body

Media type: application/json

Type: object

• name: required(string - pattern: ^.{1,30}$)

  Table name.

• description: (string)

  Description and notes for this table.

• orderIndex: (number)

  Specifies the sequence or position of the table in the report.

• query: required(object)

  The query used to retrieve data for the table.

  • application: required(string)

    Application name.

  • timestampColumn: (string)

    Elastic timestamp column name to search.

  • from: required(string)

    Specify the start of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

  • to: required(string)

    Specify the end of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

  • dimensions: required(array of table.DimensionColumn)

    List of columns that going to be used as group by queries dimensions.

    Items: DimensionColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

    • defaultValue: (any)

      Value substituted when the dimension's source value is absent, null, or empty string. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

    • useDefaultValue: (boolean)

      When true, missing/null/empty dimension values are replaced with defaultValue. Defaults to false (existing behaviour preserved).

  • columns: required(array of table.AggregationColumn)

    Specifies the aggregation columns.

    Items: AggregationColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type.

    • function: required(one of SUM, AVG, MIN, MAX, COUNT, LAST)

      Aggregation function to be applied.

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

    • defaultValue: (any)

      Value substituted when the aggregation result is absent or null. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

    • useDefaultValue: (boolean)

      When true, null/absent aggregation results are replaced with defaultValue. Additionally, when at least one aggregation column has this enabled, rows are created for dimension members (e.g. from metadata) that have no analytics data, with aggregation columns filled from their configured defaults. Defaults to false (existing behaviour preserved).

  • timeDimension: required(array of table.TimeHistDimensionColumn)

    Time histogram component of the group by queries dimensions.

    Items: TimeHistDimensionColumn

    • name: (string)

      Column display name. Path defaults to column name if not provided.

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Expected column type.

    • calendarInterval: required(string)

      Calendar interval passed to the elasticsearch.

    • expression: (string)

      A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

      Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

      Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

      Example:

      {{column}} km/h
      {{#dateTime}}{{column}}{{/dateTime}}
      {{#dateOnly}}{{column}}{{/dateOnly}}
      {{#timeOnly}}{{column}}{{/timeOnly}}
      {{#round}}{{column}}{{/round}}
      {{#round1}}{{column}}{{/round1}}
      {{#round2}}{{column}}{{/round2}}
      {{#iff}}{{column}}|Active|Inactive{{/iff}}
      

    • orderIndex: (number)

      Specifies the sequence or position of the column in the table.

  • where: required(array of table.WhereColumn)

    Filter conditions to be applied to the data.

    Items: WhereColumn

    • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

      Origin from which this column will be queried.

    • path: required(string)

      Path for the target metric in the datasource.

    • type: required(one of STRING, NUMBER, DATE, BOOL)

      Column type.

    • function: required(one of EQ, IN, LAST, IN_RANGE)

      Filter function to be applied.

    • value: required(object)

      Value to be applied for filtering.
    • from: required(string)

      Used for filtering in the IN_RANGE function.

    • to: required(string)

      Used for filtering in the IN_RANGE function.

Example:

{
  "name": "Sensor humidity readings",
  "description": "Sensor FMC-500",
  "query": {
    "dimensions": [
      {
        "source": "METADATA",
        "path": "name",
        "type": "STRING",
        "useDefaultValue": true,
        "defaultValue": "unknown"
      },
      {
        "source": "TIME_SERIES",
        "path": "endpointId",
        "type": "NUMBER"
      },
      {
        "source": "TIME_SERIES",
        "name": "humidity",
        "path": "auto~humidity",
        "type": "NUMBER"
      }
    ],
    "application": "cnc5h752908c73fp4pd0",
    "from": "now-1h",
    "to": "now"
  }
}

URI Parameters

• templateId: required(string)

  Template ID.

• tableId: required(string)

  Table ID.

URI Parameters

• templateId: required(string)

  Template ID.

• tableId: required(string)

  Table ID.

HTTP status code 200

Item is successfully retrieved.

Body

Media type: application/json

Type: any

Example:

{
  "subject": "Kaaiot Report",
  "template": "<html><body><div><p>Kaa Report</p><a href=\"{{report_download_link}}\"class=\"btn\">Download report</a></div></body></html>"
}

HTTP status code 200

Item is successfully retrieved.

Body

Media type: application/json

Type: any

Example:

{
  "template": "<html><body><table><tbody><#list table.rows as row><tr><#list row as cell><td>${cell!}</td></#list></tr></#list></tbody></table></body></html>"
}

HTTP status code 200

Item is successfully retrieved.

Body

Media type: application/json

Type: any

Example:

{
  "template": "${table.headers?join(\",\")}<#list table.rows as row>${row?join(\",\")}</#list>"
}

HTTP status code 200

The default template is successfully retrieved and prepared for download.

Headers

• Content-Disposition: required(string)

  The filename of the downloaded Excel template.

  Example:

  attachment; filename="default-excel-template.xlsx"

Body

Media type: application/octet-stream

Type: any

Body

Media type: application/json

Type: object

• name: required(string)

  Trigger name.

• type: required(CRON)

  Specifies the type of trigger mechanism.

• description: (string)

  Description and notes for this trigger.

• cronLine: required(string)

  Quartz cron line.

• poolIds: (array of string)

  An array of the unique identifiers of the pools to which the trigger should be attached.

Example:

{
  "name": "Monthly Trigger",
  "description": "On the last day of the month, every month",
  "type": "CRON",
  "cronLine": "0 0 0 L * ?",
  "poolIds": [
    "aXJuOnJjNzNkYmg3cTA6aWFtY29yZTo0YXRjaWNuaXNnOjpwb29sL2Rldg=="
  ]
}

Query Parameters

• triggerId: (array of )

  Trigger Ids.

• name: (string)

  Trigger name. Supports partial match.

• page: (number - default: 0)

  Page number.

  Example:

  0

• size: (number - default: 100)

  Page size.

  Example:

  10

• sort: (one of createdAt, updatedAt - default: createdAt)

  Field to sort by.

  Example:

  updatedAt

• sortOrder: (one of asc, desc - default: desc)

  Sort direction.

  Example:

  asc

URI Parameters

• triggerId: required(string)

  Trigger ID.

Body

Media type: application/json

Type: object

• name: required(string)

  Trigger name.

• type: required(CRON)

  Specifies the type of trigger mechanism.

• description: (string)

  Description and notes for this trigger.

• cronLine: required(string)

  Quartz cron line.

Example:

{
  "name": "Monthly Trigger",
  "description": "On the last day of the month, every month",
  "type": "CRON",
  "cronLine": "0 0 0 L * ?"
}

URI Parameters

• triggerId: required(string)

  Trigger ID.

URI Parameters

• triggerId: required(string)

  Trigger ID.

Query Parameters

• taskId: (array of )

  Task IDs.

• templateId: (array of )

  Template IDs.

• templateName: (array of )

  Template name. Supports partial match.

• triggerId: (string)

  Trigger ID.

• triggerName: (string)

  Trigger name. Supports partial match.

• type: (one of IN_PROGRESS, DONE, FAILED)

  Trigger type.

• page: (number - default: 0)

  Page number.

  Example:

  0

• size: (number - default: 100)

  Page size.

  Example:

  10

• sort: (one of createdAt, updatedAt - default: createdAt)

  Field to sort by.

  Example:

  updatedAt

• sortOrder: (one of asc, desc - default: desc)

  Sort direction.

  Example:

  asc

Body

Media type: application/json

Type: object

• reportName: required(string)

  The name of the report to be generated.

  Can include the following placeholders:

  • "{{createdDate}}"
  • "{{createdDateTime}}"
  • "{{fromDate}}"
  • "{{fromDateTime}}"
  • "{{toDate}}"
  • "{{toDateTime}}"

  Example:

  Report_Name_{{createdDate}}

• exportType: (one of CSV_IN_ZIP, PDF, EXCEL - default: CSV_IN_ZIP)

  The format of the report in which the notification will be sent.

• exportTemplate: (object)

  Offers customization options to define the layout and content of report exports.

  Placeholders for report data:

  • "${reportName}": The name of the report.
  • "${reportCreatedDate}": The creation date of the report.
  • "${reportCreatedDateTime}": The creation date and time of the report.

  Placeholders for each table:

  • "${table.name}": Table name.
  • "${table.description}": Table description.
  • "${table.application}": Application name.
  • "${table.fromDate}": Start date of the table data.
  • "${table.fromDateTime}": Start date and time of the table data.
  • "${table.toDate}": End date of the table data.
  • "${table.toDateTime}": End date and time of the table data.
  • "${table.headers}": Table headers.
  • "${table.data}": Table data.

  If not provided, a default template will be used.

  • pdfTemplate: (string)

    Content of the FreeMarker template for customizing PDF report exports.

  • csvTemplate: (string)

    Content of the FreeMarker template for customizing CSV report exports.

• emailTemplate: (object)

  Notifies recipients that a report has been generated and is available for download.

  • recipients: (array of string)

    A list of email addresses of the recipients.

  • subject: (string - default: Kaaiot Report)

    The subject line of the email notification.

  • template: (string)

    The HTML content of the email notification. If not provided, a default template will be used.

    Can include the following placeholders:

    • "{{report_download_link}}": Link to download the report.
    • "{{report_name}}": Name of the generated report.
    • "{{year}}": Current year.
• tables: required(array of table.UpsertRequest)

  List of table templates.

  Items: UpsertRequest

  • name: required(string - pattern: ^.{1,30}$)

    Table name.

  • description: (string)

    Description and notes for this table.

  • orderIndex: (number)

    Specifies the sequence or position of the table in the report.

  • query: required(object)

    The query used to retrieve data for the table.

    • application: required(string)

      Application name.

    • timestampColumn: (string)

      Elastic timestamp column name to search.

    • from: required(string)

      Specify the start of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

    • to: required(string)

      Specify the end of the time window using date expressions (e.g., now, now-1h) or a specific timestamp in ISO 8601 format.

    • dimensions: required(array of table.DimensionColumn)

      List of columns that going to be used as group by queries dimensions.

      Items: DimensionColumn

      • name: (string)

        Column display name. Path defaults to column name if not provided.

      • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

        Origin from which this column will be queried.

      • path: required(string)

        Path for the target metric in the datasource.

      • type: required(one of STRING, NUMBER, DATE, BOOL)

        Expected column type

      • expression: (string)

        A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

        Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

        Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

        Example:

        {{column}} km/h
        {{#dateTime}}{{column}}{{/dateTime}}
        {{#dateOnly}}{{column}}{{/dateOnly}}
        {{#timeOnly}}{{column}}{{/timeOnly}}
        {{#round}}{{column}}{{/round}}
        {{#round1}}{{column}}{{/round1}}
        {{#round2}}{{column}}{{/round2}}
        {{#iff}}{{column}}|Active|Inactive{{/iff}}
        

      • orderIndex: (number)

        Specifies the sequence or position of the column in the table.

      • defaultValue: (any)

        Value substituted when the dimension's source value is absent, null, or empty string. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

      • useDefaultValue: (boolean)

        When true, missing/null/empty dimension values are replaced with defaultValue. Defaults to false (existing behaviour preserved).

    • columns: required(array of table.AggregationColumn)

      Specifies the aggregation columns.

      Items: AggregationColumn

      • name: (string)

        Column display name. Path defaults to column name if not provided.

      • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

        Origin from which this column will be queried.

      • path: required(string)

        Path for the target metric in the datasource.

      • type: required(one of STRING, NUMBER, DATE, BOOL)

        Expected column type.

      • function: required(one of SUM, AVG, MIN, MAX, COUNT, LAST)

        Aggregation function to be applied.

      • expression: (string)

        A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

        Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

        Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

        Example:

        {{column}} km/h
        {{#dateTime}}{{column}}{{/dateTime}}
        {{#dateOnly}}{{column}}{{/dateOnly}}
        {{#timeOnly}}{{column}}{{/timeOnly}}
        {{#round}}{{column}}{{/round}}
        {{#round1}}{{column}}{{/round1}}
        {{#round2}}{{column}}{{/round2}}
        {{#iff}}{{column}}|Active|Inactive{{/iff}}
        

      • orderIndex: (number)

        Specifies the sequence or position of the column in the table.

      • defaultValue: (any)

        Value substituted when the aggregation result is absent or null. Must be consistent with type (NUMBER -> number, BOOL -> boolean, DATE -> ISO-8601 string, STRING -> string). Only applied when useDefaultValue is true.

      • useDefaultValue: (boolean)

        When true, null/absent aggregation results are replaced with defaultValue. Additionally, when at least one aggregation column has this enabled, rows are created for dimension members (e.g. from metadata) that have no analytics data, with aggregation columns filled from their configured defaults. Defaults to false (existing behaviour preserved).

    • timeDimension: required(array of table.TimeHistDimensionColumn)

      Time histogram component of the group by queries dimensions.

      Items: TimeHistDimensionColumn

      • name: (string)

        Column display name. Path defaults to column name if not provided.

      • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

        Origin from which this column will be queried.

      • path: required(string)

        Path for the target metric in the datasource.

      • type: required(one of STRING, NUMBER, DATE, BOOL)

        Expected column type.

      • calendarInterval: required(string)

        Calendar interval passed to the elasticsearch.

      • expression: (string)

        A Mustache expression used to transform or format a column value. The expression is applied per row and replaces the column's existing value with the expression result. Any other column in the same row can be referenced by name (e.g. {{speed}}), and the built-in lambdas below can be applied as Mustache sections. Lambdas may be nested, and column references / lambdas inside another lambda's body are resolved before the outer lambda is applied.

        Built-in lambdas: {{column}} Raw value of the referenced column. {{#round}}{{column}}{{/round}} Round down to 0 decimal places. {{#round1}}{{column}}{{/round1}} Round down to 1 decimal place. {{#round2}}{{column}}{{/round2}} Round down to 2 decimal places. {{#dateTime}}{{column}}{{/dateTime}} Format an epoch-millis or ISO timestamp as d MMM yyyy HH:mm. {{#dateOnly}}{{column}}{{/dateOnly}} Format an epoch-millis or ISO timestamp as dd MMM yyyy. {{#timeOnly}}{{column}}{{/timeOnly}} Format an epoch-millis or ISO timestamp as HH:mm:ss. {{#iff}}{{column}}|trueText|falseText{{/iff}} Conditional (ternary) expression. Renders trueText when the value is truthy, otherwise falseText. Falsy values: empty, 0, 0.0, any numeric zero, false, null (case-insensitive). All other values are truthy. Whitespace around each of the three parts is trimmed; the false branch may be omitted ({{column}}|trueText|) and renders as empty. Pipe characters inside the branch text are preserved.

        Note: an expression is only applied when the column has a present, non-null value in the row. For aggregation columns that may yield null (for example AVG over documents missing the field), set useDefaultValue together with defaultValue on the column so the expression is evaluated on every row.

        Example:

        {{column}} km/h
        {{#dateTime}}{{column}}{{/dateTime}}
        {{#dateOnly}}{{column}}{{/dateOnly}}
        {{#timeOnly}}{{column}}{{/timeOnly}}
        {{#round}}{{column}}{{/round}}
        {{#round1}}{{column}}{{/round1}}
        {{#round2}}{{column}}{{/round2}}
        {{#iff}}{{column}}|Active|Inactive{{/iff}}
        

      • orderIndex: (number)

        Specifies the sequence or position of the column in the table.

    • where: required(array of table.WhereColumn)

      Filter conditions to be applied to the data.

      Items: WhereColumn

      • source: required(one of ANALYTICS, METADATA, ASSETS, TIME_SERIES)

        Origin from which this column will be queried.

      • path: required(string)

        Path for the target metric in the datasource.

      • type: required(one of STRING, NUMBER, DATE, BOOL)

        Column type.

      • function: required(one of EQ, IN, LAST, IN_RANGE)

        Filter function to be applied.

      • value: required(object)

        Value to be applied for filtering.
      • from: required(string)

        Used for filtering in the IN_RANGE function.

      • to: required(string)

        Used for filtering in the IN_RANGE function.

Example:

{
  "reportName": "sensor__readings__{{createdDate}}",
  "exportType": "PDF",
  "exportTemplate": {
    "pdfTemplate": "<html><head><table><thead><tr><#list table.headers as header><th>${header}</th></#list></tr></thead></table></#list></body></html>",
    "csvTemplate": "${table.headers?join(\",\")}"
  },
  "emailTemplate": {
    "subject": "Sensor Readings Report",
    "template": "<html><body><p>{{report_name}}</p></body></html>",
    "recipients": [
      "example@kaaiot.io"
    ]
  },
  "tables": [
    {
      "name": "Sensor humidity readings",
      "description": "Sensor FMC-500",
      "query": {
        "dimensions": [
          {
            "source": "METADATA",
            "path": "name",
            "type": "STRING"
          },
          {
            "source": "TIME_SERIES",
            "path": "endpointId",
            "type": "NUMBER"
          },
          {
            "source": "TIME_SERIES",
            "name": "humidity",
            "path": "auto~humidity",
            "type": "NUMBER"
          }
        ],
        "application": "cnc5h752908c73fp4pd0",
        "from": "now-1M",
        "to": "now"
      }
    }
  ]
}

URI Parameters

• templateId: required(string)

  Template ID.

Query Parameters

• reportId: (string)

  Report identifier, can be one or multiple.

  Example:

  d1466785-6498-4a7b-ae5b-b1bbc14986ff

• templateId: (string)

  Template identifier, can be one or multiple.

  Example:

  4a2ab67a-b5d7-4919-96e0-127d7d558e5a

• name: (string)

  Report name. Supports partial match.

  Example:

  Monitoring

• page: (number - default: 0)

  Page number.

  Example:

  0

• size: (number - default: 100)

  Page size.

  Example:

  10

• sort: (one of createdAt, updatedAt - default: createdAt)

  Field to sort by.

  Example:

  updatedAt

• sortOrder: (one of asc, desc - default: desc)

  Sort direction.

  Example:

  asc

URI Parameters

• reportId: required(string)

  Identifier of the report to operate on.

  Example:

  d1466785-6498-4a7b-ae5b-b1bbc14986ff

URI Parameters

• reportId: required(string)

  Identifier of the report to operate on.

  Example:

  d1466785-6498-4a7b-ae5b-b1bbc14986ff

Query Parameters

• exportType: required(one of CSV_IN_ZIP, PDF, EXCEL)

  Report export type.