Skip to content
AWS for Query.Farm

aws.quicksight.describe_topic

Example SQL Queries

SELECT * FROM
aws.quicksight.describe_topic
WHERE
"aws_account_id" = 'VALUE'
AND "topic_id" = 'VALUE';

Description

Describes a topic.

Table Definition

Column NameColumn Data Type
aws_account_id Required Input Column

The Amazon Web Services account ID.

VARCHAR
topic_id Required Input Column

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The Amazon Resource Name (ARN) of the topic.

VARCHAR
request_id

The Amazon Web Services request ID for this operation.

VARCHAR
status

The HTTP status of the request.

BIGINT
topic

The definition of a topic.

STRUCT(
    "name" VARCHAR,
    "description" VARCHAR,
    "user_experience_version" VARCHAR,
    "data_sets" STRUCT(
        "dataset_arn" VARCHAR,
        "dataset_name" VARCHAR,
        "dataset_description" VARCHAR,
        "data_aggregation" STRUCT(
            "dataset_row_date_granularity" VARCHAR,
            "default_date_column_name" VARCHAR
        ),
        "filters" STRUCT(
            "filter_description" VARCHAR,
            "filter_class" VARCHAR,
            "filter_name" VARCHAR,
            "filter_synonyms" VARCHAR[],
            "operand_field_name" VARCHAR,
            "filter_type" VARCHAR,
            "category_filter" STRUCT(
                "category_filter_function" VARCHAR,
                "category_filter_type" VARCHAR,
                "constant" STRUCT(
                    "constant_type" VARCHAR,
                    "singular_constant" VARCHAR,
                    "collective_constant" STRUCT(
                        "value_list" VARCHAR[]
                    )
                ),
                "inverse" BOOLEAN
            ),
            "numeric_equality_filter" STRUCT(
                "constant" STRUCT(
                    "constant_type" VARCHAR,
                    "singular_constant" VARCHAR
                ),
                "aggregation" VARCHAR
            ),
            "numeric_range_filter" STRUCT(
                "inclusive" BOOLEAN,
                "constant" STRUCT(
                    "constant_type" VARCHAR,
                    "range_constant" STRUCT(
                        "minimum" VARCHAR,
                        "maximum" VARCHAR
                    )
                ),
                "aggregation" VARCHAR
            ),
            "date_range_filter" STRUCT(
                "inclusive" BOOLEAN,
                "constant" STRUCT(
                    "constant_type" VARCHAR,
                    "range_constant" STRUCT(
                        "minimum" VARCHAR,
                        "maximum" VARCHAR
                    )
                )
            ),
            "relative_date_filter" STRUCT(
                "time_granularity" VARCHAR,
                "relative_date_filter_function" VARCHAR,
                "constant" STRUCT(
                    "constant_type" VARCHAR,
                    "singular_constant" VARCHAR
                )
            )
        )[],
        "columns" STRUCT(
            "column_name" VARCHAR,
            "column_friendly_name" VARCHAR,
            "column_description" VARCHAR,
            "column_synonyms" VARCHAR[],
            "column_data_role" VARCHAR,
            "aggregation" VARCHAR,
            "is_included_in_topic" BOOLEAN,
            "disable_indexing" BOOLEAN,
            "comparative_order" STRUCT(
                "use_ordering" VARCHAR,
                "specifed_order" VARCHAR[],
                "treat_undefined_specified_values" VARCHAR
            ),
            "semantic_type" STRUCT(
                "type_name" VARCHAR,
                "sub_type_name" VARCHAR,
                "type_parameters" MAP(VARCHAR, VARCHAR),
                "truthy_cell_value" VARCHAR,
                "truthy_cell_value_synonyms" VARCHAR[],
                "falsey_cell_value" VARCHAR,
                "falsey_cell_value_synonyms" VARCHAR[]
            ),
            "time_granularity" VARCHAR,
            "allowed_aggregations" VARCHAR[],
            "not_allowed_aggregations" VARCHAR[],
            "default_formatting" STRUCT(
                "display_format" VARCHAR,
                "display_format_options" STRUCT(
                    "use_blank_cell_format" BOOLEAN,
                    "blank_cell_format" VARCHAR,
                    "date_format" VARCHAR,
                    "decimal_separator" VARCHAR,
                    "grouping_separator" VARCHAR,
                    "use_grouping" BOOLEAN,
                    "fraction_digits" BIGINT,
                    "prefix" VARCHAR,
                    "suffix" VARCHAR,
                    "unit_scaler" VARCHAR,
                    "negative_format" STRUCT(
                        "prefix" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "currency_symbol" VARCHAR
                )
            ),
            "never_aggregate_in_filter" BOOLEAN,
            "cell_value_synonyms" STRUCT(
                "cell_value" VARCHAR,
                "synonyms" VARCHAR[]
            )[],
            "non_additive" BOOLEAN
        )[],
        "calculated_fields" STRUCT(
            "calculated_field_name" VARCHAR,
            "calculated_field_description" VARCHAR,
            "expression" VARCHAR,
            "calculated_field_synonyms" VARCHAR[],
            "is_included_in_topic" BOOLEAN,
            "disable_indexing" BOOLEAN,
            "column_data_role" VARCHAR,
            "time_granularity" VARCHAR,
            "default_formatting" STRUCT(
                "display_format" VARCHAR,
                "display_format_options" STRUCT(
                    "use_blank_cell_format" BOOLEAN,
                    "blank_cell_format" VARCHAR,
                    "date_format" VARCHAR,
                    "decimal_separator" VARCHAR,
                    "grouping_separator" VARCHAR,
                    "use_grouping" BOOLEAN,
                    "fraction_digits" BIGINT,
                    "prefix" VARCHAR,
                    "suffix" VARCHAR,
                    "unit_scaler" VARCHAR,
                    "negative_format" STRUCT(
                        "prefix" VARCHAR,
                        "suffix" VARCHAR
                    ),
                    "currency_symbol" VARCHAR
                )
            ),
            "aggregation" VARCHAR,
            "comparative_order" STRUCT(
                "use_ordering" VARCHAR,
                "specifed_order" VARCHAR[],
                "treat_undefined_specified_values" VARCHAR
            ),
            "semantic_type" STRUCT(
                "type_name" VARCHAR,
                "sub_type_name" VARCHAR,
                "type_parameters" MAP(VARCHAR, VARCHAR),
                "truthy_cell_value" VARCHAR,
                "truthy_cell_value_synonyms" VARCHAR[],
                "falsey_cell_value" VARCHAR,
                "falsey_cell_value_synonyms" VARCHAR[]
            ),
            "allowed_aggregations" VARCHAR[],
            "not_allowed_aggregations" VARCHAR[],
            "never_aggregate_in_filter" BOOLEAN,
            "cell_value_synonyms" STRUCT(
                "cell_value" VARCHAR,
                "synonyms" VARCHAR[]
            )[],
            "non_additive" BOOLEAN
        )[],
        "named_entities" STRUCT(
            "entity_name" VARCHAR,
            "entity_description" VARCHAR,
            "entity_synonyms" VARCHAR[],
            "semantic_entity_type" STRUCT(
                "type_name" VARCHAR,
                "sub_type_name" VARCHAR,
                "type_parameters" MAP(VARCHAR, VARCHAR)
            ),
            "definition" STRUCT(
                "field_name" VARCHAR,
                "property_name" VARCHAR,
                "property_role" VARCHAR,
                "property_usage" VARCHAR,
                "metric" STRUCT(
                    "aggregation" VARCHAR,
                    "aggregation_function_parameters" MAP(VARCHAR, VARCHAR)
                )
            )[]
        )[]
    )[]
)
Show child fields
topic.data_sets[]
Show child fields
topic.data_sets[].calculated_fields[]
Show child fields
topic.data_sets[].calculated_fields[].aggregation

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

topic.data_sets[].calculated_fields[].allowed_aggregations[]
topic.data_sets[].calculated_fields[].calculated_field_description

The calculated field description.

topic.data_sets[].calculated_fields[].calculated_field_name

The calculated field name.

topic.data_sets[].calculated_fields[].calculated_field_synonyms[]
topic.data_sets[].calculated_fields[].cell_value_synonyms[]
Show child fields
topic.data_sets[].calculated_fields[].cell_value_synonyms[].cell_value

The cell value.

topic.data_sets[].calculated_fields[].cell_value_synonyms[].synonyms[]
topic.data_sets[].calculated_fields[].column_data_role

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

topic.data_sets[].calculated_fields[].comparative_order

The order in which data is displayed for the calculated field when it's used in a comparative context.

Show child fields
topic.data_sets[].calculated_fields[].comparative_order.specifed_order[]
topic.data_sets[].calculated_fields[].comparative_order.treat_undefined_specified_values

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

topic.data_sets[].calculated_fields[].comparative_order.use_ordering

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

topic.data_sets[].calculated_fields[].default_formatting

The default formatting definition.

Show child fields
topic.data_sets[].calculated_fields[].default_formatting.display_format

The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options

The additional options for display formatting.

Show child fields
topic.data_sets[].calculated_fields[].default_formatting.display_format_options.blank_cell_format

Determines the blank cell format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.currency_symbol

The currency symbol, such as USD.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.date_format

Determines the DateTime format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.decimal_separator

Determines the decimal separator.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.fraction_digits

Determines the number of fraction digits.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.grouping_separator

Determines the grouping separator.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.negative_format

The negative format.

Show child fields
topic.data_sets[].calculated_fields[].default_formatting.display_format_options.negative_format.prefix

The prefix for a negative format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.negative_format.suffix

The suffix for a negative format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.prefix

The prefix value for a display format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.suffix

The suffix value for a display format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.unit_scaler

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.use_blank_cell_format

A Boolean value that indicates whether to use blank cell format.

topic.data_sets[].calculated_fields[].default_formatting.display_format_options.use_grouping

A Boolean value that indicates whether to use grouping.

topic.data_sets[].calculated_fields[].disable_indexing

A Boolean value that indicates if a calculated field is visible in the autocomplete.

topic.data_sets[].calculated_fields[].expression

The calculated field expression.

topic.data_sets[].calculated_fields[].is_included_in_topic

A boolean value that indicates if a calculated field is included in the topic.

topic.data_sets[].calculated_fields[].never_aggregate_in_filter

A Boolean value that indicates whether to never aggregate calculated field in filters.

topic.data_sets[].calculated_fields[].non_additive

The non additive for the table style target.

topic.data_sets[].calculated_fields[].not_allowed_aggregations[]
topic.data_sets[].calculated_fields[].semantic_type

The semantic type.

Show child fields
topic.data_sets[].calculated_fields[].semantic_type.falsey_cell_value

The semantic type falsey cell value.

topic.data_sets[].calculated_fields[].semantic_type.falsey_cell_value_synonyms[]
topic.data_sets[].calculated_fields[].semantic_type.sub_type_name

The semantic type sub type name.

topic.data_sets[].calculated_fields[].semantic_type.truthy_cell_value

The semantic type truthy cell value.

topic.data_sets[].calculated_fields[].semantic_type.truthy_cell_value_synonyms[]
topic.data_sets[].calculated_fields[].semantic_type.type_name

The semantic type name.

topic.data_sets[].calculated_fields[].semantic_type.type_parameters

The semantic type parameters.

topic.data_sets[].calculated_fields[].time_granularity

The level of time precision that is used to aggregate DateTime values.

topic.data_sets[].columns[]
Show child fields
topic.data_sets[].columns[].aggregation

The type of aggregation that is performed on the column data when it's queried.

topic.data_sets[].columns[].allowed_aggregations[]
topic.data_sets[].columns[].cell_value_synonyms[]
Show child fields
topic.data_sets[].columns[].cell_value_synonyms[].cell_value

The cell value.

topic.data_sets[].columns[].cell_value_synonyms[].synonyms[]
topic.data_sets[].columns[].column_data_role

The role of the column in the data. Valid values are DIMENSION and MEASURE.

topic.data_sets[].columns[].column_description

A description of the column and its contents.

topic.data_sets[].columns[].column_friendly_name

A user-friendly name for the column.

topic.data_sets[].columns[].column_name

The name of the column.

topic.data_sets[].columns[].column_synonyms[]
topic.data_sets[].columns[].comparative_order

The order in which data is displayed for the column when it's used in a comparative context.

Show child fields
topic.data_sets[].columns[].comparative_order.specifed_order[]
topic.data_sets[].columns[].comparative_order.treat_undefined_specified_values

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

topic.data_sets[].columns[].comparative_order.use_ordering

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

topic.data_sets[].columns[].default_formatting

The default formatting used for values in the column.

Show child fields
topic.data_sets[].columns[].default_formatting.display_format

The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.

topic.data_sets[].columns[].default_formatting.display_format_options

The additional options for display formatting.

Show child fields
topic.data_sets[].columns[].default_formatting.display_format_options.blank_cell_format

Determines the blank cell format.

topic.data_sets[].columns[].default_formatting.display_format_options.currency_symbol

The currency symbol, such as USD.

topic.data_sets[].columns[].default_formatting.display_format_options.date_format

Determines the DateTime format.

topic.data_sets[].columns[].default_formatting.display_format_options.decimal_separator

Determines the decimal separator.

topic.data_sets[].columns[].default_formatting.display_format_options.fraction_digits

Determines the number of fraction digits.

topic.data_sets[].columns[].default_formatting.display_format_options.grouping_separator

Determines the grouping separator.

topic.data_sets[].columns[].default_formatting.display_format_options.negative_format

The negative format.

Show child fields
topic.data_sets[].columns[].default_formatting.display_format_options.negative_format.prefix

The prefix for a negative format.

topic.data_sets[].columns[].default_formatting.display_format_options.negative_format.suffix

The suffix for a negative format.

topic.data_sets[].columns[].default_formatting.display_format_options.prefix

The prefix value for a display format.

topic.data_sets[].columns[].default_formatting.display_format_options.suffix

The suffix value for a display format.

topic.data_sets[].columns[].default_formatting.display_format_options.unit_scaler

The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.

topic.data_sets[].columns[].default_formatting.display_format_options.use_blank_cell_format

A Boolean value that indicates whether to use blank cell format.

topic.data_sets[].columns[].default_formatting.display_format_options.use_grouping

A Boolean value that indicates whether to use grouping.

topic.data_sets[].columns[].disable_indexing

A Boolean value that indicates whether the column shows in the autocomplete functionality.

topic.data_sets[].columns[].is_included_in_topic

A Boolean value that indicates whether the column is included in the query results.

topic.data_sets[].columns[].never_aggregate_in_filter

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

topic.data_sets[].columns[].non_additive

The non additive value for the column.

topic.data_sets[].columns[].not_allowed_aggregations[]
topic.data_sets[].columns[].semantic_type

The semantic type of data contained in the column.

Show child fields
topic.data_sets[].columns[].semantic_type.falsey_cell_value

The semantic type falsey cell value.

topic.data_sets[].columns[].semantic_type.falsey_cell_value_synonyms[]
topic.data_sets[].columns[].semantic_type.sub_type_name

The semantic type sub type name.

topic.data_sets[].columns[].semantic_type.truthy_cell_value

The semantic type truthy cell value.

topic.data_sets[].columns[].semantic_type.truthy_cell_value_synonyms[]
topic.data_sets[].columns[].semantic_type.type_name

The semantic type name.

topic.data_sets[].columns[].semantic_type.type_parameters

The semantic type parameters.

topic.data_sets[].columns[].time_granularity

The level of time precision that is used to aggregate DateTime values.

topic.data_sets[].data_aggregation

The definition of a data aggregation.

Show child fields
topic.data_sets[].data_aggregation.dataset_row_date_granularity

The level of time precision that is used to aggregate DateTime values.

topic.data_sets[].data_aggregation.default_date_column_name

The column name for the default date.

topic.data_sets[].dataset_arn

The Amazon Resource Name (ARN) of the dataset.

topic.data_sets[].dataset_description

The description of the dataset.

topic.data_sets[].dataset_name

The name of the dataset.

topic.data_sets[].filters[]
Show child fields
topic.data_sets[].filters[].category_filter

The category filter that is associated with this filter.

Show child fields
topic.data_sets[].filters[].category_filter.category_filter_function

The category filter function. Valid values for this structure are EXACT and CONTAINS.

topic.data_sets[].filters[].category_filter.category_filter_type

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

topic.data_sets[].filters[].category_filter.constant

The constant used in a category filter.

Show child fields
topic.data_sets[].filters[].category_filter.constant.collective_constant

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

Show child fields
topic.data_sets[].filters[].category_filter.constant.collective_constant.value_list[]
topic.data_sets[].filters[].category_filter.constant.constant_type

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

topic.data_sets[].filters[].category_filter.constant.singular_constant

A singular constant used in a category filter. This element is used to specify a single value for the constant.

topic.data_sets[].filters[].category_filter.inverse

A Boolean value that indicates if the filter is inverse.

topic.data_sets[].filters[].date_range_filter

The date range filter.

Show child fields
topic.data_sets[].filters[].date_range_filter.constant

The constant used in a date range filter.

Show child fields
topic.data_sets[].filters[].date_range_filter.constant.constant_type

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

topic.data_sets[].filters[].date_range_filter.constant.range_constant

The value of the constant that is used to specify the endpoints of a range filter.

Show child fields
topic.data_sets[].filters[].date_range_filter.constant.range_constant.maximum

The maximum value for a range constant.

topic.data_sets[].filters[].date_range_filter.constant.range_constant.minimum

The minimum value for a range constant.

topic.data_sets[].filters[].date_range_filter.inclusive

A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.

topic.data_sets[].filters[].filter_class

The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.

topic.data_sets[].filters[].filter_description

A description of the filter used to select items for a topic.

topic.data_sets[].filters[].filter_name

The name of the filter.

topic.data_sets[].filters[].filter_synonyms[]
topic.data_sets[].filters[].filter_type

The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.

topic.data_sets[].filters[].numeric_equality_filter

The numeric equality filter.

Show child fields
topic.data_sets[].filters[].numeric_equality_filter.aggregation

An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

topic.data_sets[].filters[].numeric_equality_filter.constant

The constant used in a numeric equality filter.

Show child fields
topic.data_sets[].filters[].numeric_equality_filter.constant.constant_type

The type of the singular filter constant. Valid values for this structure are SINGULAR.

topic.data_sets[].filters[].numeric_equality_filter.constant.singular_constant

The value of the singular filter constant.

topic.data_sets[].filters[].numeric_range_filter

The numeric range filter.

Show child fields
topic.data_sets[].filters[].numeric_range_filter.aggregation

An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.

topic.data_sets[].filters[].numeric_range_filter.constant

The constant used in a numeric range filter.

Show child fields
topic.data_sets[].filters[].numeric_range_filter.constant.constant_type

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

topic.data_sets[].filters[].numeric_range_filter.constant.range_constant

The value of the constant that is used to specify the endpoints of a range filter.

Show child fields
topic.data_sets[].filters[].numeric_range_filter.constant.range_constant.maximum

The maximum value for a range constant.

topic.data_sets[].filters[].numeric_range_filter.constant.range_constant.minimum

The minimum value for a range constant.

topic.data_sets[].filters[].numeric_range_filter.inclusive

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.

topic.data_sets[].filters[].operand_field_name

The name of the field that the filter operates on.

topic.data_sets[].filters[].relative_date_filter

The relative date filter.

Show child fields
topic.data_sets[].filters[].relative_date_filter.constant

The constant used in a relative date filter.

Show child fields
topic.data_sets[].filters[].relative_date_filter.constant.constant_type

The type of the singular filter constant. Valid values for this structure are SINGULAR.

topic.data_sets[].filters[].relative_date_filter.constant.singular_constant

The value of the singular filter constant.

topic.data_sets[].filters[].relative_date_filter.relative_date_filter_function

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

topic.data_sets[].filters[].relative_date_filter.time_granularity

The level of time precision that is used to aggregate DateTime values.

topic.data_sets[].named_entities[]
Show child fields
topic.data_sets[].named_entities[].definition[]
Show child fields
topic.data_sets[].named_entities[].definition[].field_name

The name of the entity.

topic.data_sets[].named_entities[].definition[].metric

The definition of a metric.

Show child fields
topic.data_sets[].named_entities[].definition[].metric.aggregation

The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.

topic.data_sets[].named_entities[].definition[].metric.aggregation_function_parameters

The additional parameters for an aggregation function.

topic.data_sets[].named_entities[].definition[].property_name

The property name to be used for the named entity.

topic.data_sets[].named_entities[].definition[].property_role

The property role. Valid values for this structure are PRIMARY and ID.

topic.data_sets[].named_entities[].definition[].property_usage

The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.

topic.data_sets[].named_entities[].entity_description

The description of the named entity.

topic.data_sets[].named_entities[].entity_name

The name of the named entity.

topic.data_sets[].named_entities[].entity_synonyms[]
topic.data_sets[].named_entities[].semantic_entity_type

The type of named entity that a topic represents.

Show child fields
topic.data_sets[].named_entities[].semantic_entity_type.sub_type_name

The semantic entity sub type name.

topic.data_sets[].named_entities[].semantic_entity_type.type_name

The semantic entity type name.

topic.data_sets[].named_entities[].semantic_entity_type.type_parameters

The semantic entity type parameters.

topic.description

The description of the topic.

topic.name

The name of the topic.

topic.user_experience_version

The user experience version of a topic.