FieldDto
    • PDF

    FieldDto

    • PDF

    Article summary

    Available in Classic

    It is required when creating and editing a schema.

    Syntax

    The syntax is as follows.

    private String name;
    private DataType dataType;
    private boolean metric = false;
    private boolean dimension = false;
    private Boolean counter = false;
    private boolean isIdDimension = false;
    private Map<Interval, Set<Calculation>> aggregations;
    private String desc;
    

    Field

    The following describes the fields.

    FieldTypeRequiredDescription
    nameStringRequiredName of product schema
    dataTypeDataTypeRequiredSpecify the data type of a metric or dimension
    • If the field is a metric: STRING | INTEGER | FLOAT | LONG
    • If the field is a dimension: STRING
    metricBooleanOptionalSpecify that the field is a metric
    • true | false (default)
    dimensionBooleanOptionalSpecify that the field is a dimension
    • true | false (default)
    counterBooleanOptional
    • true | false (default)
    isIdDimensionBooleanOptionalIt can only be set when the field is a dimension and is distinguished by that dimension when creating an event rule for a user-defined product
    • default (default)
    • At least one dimension must be set to idDimension
    aggregationsMap<Interval, Set<Calculation>>OptionalIt can only be set when the field is a metric, and sets the aggregation frequency and aggregation function
    • Interval: Min1 | Min5 | Min30 | Hour2 | Day1
    • Calculation: COUNT | SUM | MAX | MIN | AVG
    descStringOptionalDescription of product schema

    Examples

    See below for an example.

    Note

    If aggregations is not set, it defaults to performing all aggregation functions for every aggregation interval as shown below.

    "aggregations": {
        "Min1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min5": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Min30": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Hour2": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ],
        "Day1": [
          "AVG",
          "SUM",
          "MIN",
          "MAX",
          "COUNT"
        ]
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.