Apps

• */*object
  Show */* properties

  • attributesobject
    Show attributes properties

    • namestring

      The name (title) of the application

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • localestring

      Set custom locale instead of the system default

    • spaceIdstring

      The space ID of the application

    • descriptionstring

      The description of the application

Application attributes and user privileges.

• application/jsonobject

  Application attributes and user privileges.

  Show application/json properties

  • createarray of objects

    Object create privileges. Hints to the client what type of objects the user is allowed to create.

    Show create properties

    • resourcestring

      Type of resource. For example, sheet, story, bookmark, etc.

    • canCreateboolean

      Is set to true if the user has privileges to create the resource.

  • attributesobject

    App attributes. This structure can also contain extra user-defined attributes.

    Show attributes properties

    • idstring

      The App ID.

    • namestring

      App name.

    • ownerstringDeprecated

      Deprecated. Use the Users API to fetch user metadata.

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • customobject

      Contains dynamic JSON data specified by the client.

    • ownerIdstring

      Identifier of the app owner.

    • encryptedboolean

      If set to true, the app is encrypted.

    • publishedboolean

      True if the app is published on-prem, distributed in QCS, false if not.

    • thumbnailstring

      App thumbnail.

    • createdDatestring

      The date and time when the app was created.

      format = "date-time"

    • descriptionstring

      App description.

    • originAppIdstring

      The Origin App ID for published apps.

    • publishTimestring

      The date and time when the app was published, empty if unpublished.

      format = "date-time"

    • dynamicColorstring

      The dynamic color of the app.

    • modifiedDatestring

      The date and time when the app was modified.

      format = "date-time"

    • lastReloadTimestring

      Date and time of the last reload of the app.

      format = "date-time"

    • hasSectionAccessboolean

      If set to true, the app has section access configured,

    • isDirectQueryModeboolean

      True if the app is a Direct Query app, false if not

  • privilegesarray of strings

    Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

    • read
    • create
    • update
    • delete
    • reload
    • import
    • publish
    • duplicate
    • export
    • exportdata
    • change_owner
    • change_space

Application attributes and user privileges.

• application/jsonobject

  Application attributes and user privileges.

  Show application/json properties

  • createarray of objects

    Object create privileges. Hints to the client what type of objects the user is allowed to create.

    Show create properties

    • resourcestring

      Type of resource. For example, sheet, story, bookmark, etc.

    • canCreateboolean

      Is set to true if the user has privileges to create the resource.

  • attributesobject

    App attributes. This structure can also contain extra user-defined attributes.

    Show attributes properties

    • idstring

      The App ID.

    • namestring

      App name.

    • ownerstringDeprecated

      Deprecated. Use the Users API to fetch user metadata.

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • customobject

      Contains dynamic JSON data specified by the client.

    • ownerIdstring

      Identifier of the app owner.

    • encryptedboolean

      If set to true, the app is encrypted.

    • publishedboolean

      True if the app is published on-prem, distributed in QCS, false if not.

    • thumbnailstring

      App thumbnail.

    • createdDatestring

      The date and time when the app was created.

      format = "date-time"

    • descriptionstring

      App description.

    • originAppIdstring

      The Origin App ID for published apps.

    • publishTimestring

      The date and time when the app was published, empty if unpublished.

      format = "date-time"

    • dynamicColorstring

      The dynamic color of the app.

    • modifiedDatestring

      The date and time when the app was modified.

      format = "date-time"

    • lastReloadTimestring

      Date and time of the last reload of the app.

      format = "date-time"

    • hasSectionAccessboolean

      If set to true, the app has section access configured,

    • isDirectQueryModeboolean

      True if the app is a Direct Query app, false if not

  • privilegesarray of strings

    Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

    • read
    • create
    • update
    • delete
    • reload
    • import
    • publish
    • duplicate
    • export
    • exportdata
    • change_owner
    • change_space

• */*object
  Show */* properties

  • attributesobject
    Show attributes properties

    • namestring

      The name (title) of the application.

    • descriptionstring

      The description of the application.

Application attributes and user privileges.

• application/jsonobject

  Application attributes and user privileges.

  Show application/json properties

  • createarray of objects

    Object create privileges. Hints to the client what type of objects the user is allowed to create.

    Show create properties

    • resourcestring

      Type of resource. For example, sheet, story, bookmark, etc.

    • canCreateboolean

      Is set to true if the user has privileges to create the resource.

  • attributesobject

    App attributes. This structure can also contain extra user-defined attributes.

    Show attributes properties

    • idstring

      The App ID.

    • namestring

      App name.

    • ownerstringDeprecated

      Deprecated. Use the Users API to fetch user metadata.

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • customobject

      Contains dynamic JSON data specified by the client.

    • ownerIdstring

      Identifier of the app owner.

    • encryptedboolean

      If set to true, the app is encrypted.

    • publishedboolean

      True if the app is published on-prem, distributed in QCS, false if not.

    • thumbnailstring

      App thumbnail.

    • createdDatestring

      The date and time when the app was created.

      format = "date-time"

    • descriptionstring

      App description.

    • originAppIdstring

      The Origin App ID for published apps.

    • publishTimestring

      The date and time when the app was published, empty if unpublished.

      format = "date-time"

    • dynamicColorstring

      The dynamic color of the app.

    • modifiedDatestring

      The date and time when the app was modified.

      format = "date-time"

    • lastReloadTimestring

      Date and time of the last reload of the app.

      format = "date-time"

    • hasSectionAccessboolean

      If set to true, the app has section access configured,

    • isDirectQueryModeboolean

      True if the app is a Direct Query app, false if not

  • privilegesarray of strings

    Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

    • read
    • create
    • update
    • delete
    • reload
    • import
    • publish
    • duplicate
    • export
    • exportdata
    • change_owner
    • change_space

• */*object
  Show */* properties

  • attributesobject
    Show attributes properties

    • namestring

      The name (title) of the application

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • localestring

      Set custom locale instead of the system default

    • spaceIdstring

      The space ID of the application

    • descriptionstring

      The description of the application

Application attributes and user privileges.

• application/jsonobject

  Application attributes and user privileges.

  Show application/json properties

  • createarray of objects

    Object create privileges. Hints to the client what type of objects the user is allowed to create.

    Show create properties

    • resourcestring

      Type of resource. For example, sheet, story, bookmark, etc.

    • canCreateboolean

      Is set to true if the user has privileges to create the resource.

  • attributesobject

    App attributes. This structure can also contain extra user-defined attributes.

    Show attributes properties

    • idstring

      The App ID.

    • namestring

      App name.

    • ownerstringDeprecated

      Deprecated. Use the Users API to fetch user metadata.

    • usagestring

      Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

    • customobject

      Contains dynamic JSON data specified by the client.

    • ownerIdstring

      Identifier of the app owner.

    • encryptedboolean

      If set to true, the app is encrypted.

    • publishedboolean

      True if the app is published on-prem, distributed in QCS, false if not.

    • thumbnailstring

      App thumbnail.

    • createdDatestring

      The date and time when the app was created.

      format = "date-time"

    • descriptionstring

      App description.

    • originAppIdstring

      The Origin App ID for published apps.

    • publishTimestring

      The date and time when the app was published, empty if unpublished.

      format = "date-time"

    • dynamicColorstring

      The dynamic color of the app.

    • modifiedDatestring

      The date and time when the app was modified.

      format = "date-time"

    • lastReloadTimestring

      Date and time of the last reload of the app.

      format = "date-time"

    • hasSectionAccessboolean

      If set to true, the app has section access configured,

    • isDirectQueryModeboolean

      True if the app is a Direct Query app, false if not

  • privilegesarray of strings

    Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

    • read
    • create
    • update
    • delete
    • reload
    • import
    • publish
    • duplicate
    • export
    • exportdata
    • change_owner
    • change_space

• application/jsonarray of objects
  Show application/json properties

  • statementstring

    The LOAD and SELECT script statements from the data load script.

  • discriminatorstring

    A string indicating the origin of the data:

    • [filename]: the data comes from a local file.
    • INLINE: the data is entered inline in the load script.
    • RESIDENT: the data comes from a resident table. The table name is listed.
    • AUTOGENERATE: the data is generated from the load script (no external table of data source).
    • Provider: the data comes from a data connection. The connector source name is listed.
    • [webfile]: the data comes from a web-based file.
    • STORE: path to QVD or TXT file where data is stored.
    • EXTENSION: the data comes from a Server Side Extension (SSE).

• application/jsonobject
  Show application/json properties

  • usagestring

    Can be one of: "ANALYTICS""DATA_PREPARATION""DATAFLOW_PREP""SINGLE_TABLE_PREP"

  • fieldsarray of objects

    List of field descriptions.

    Show fields properties

    • hashstring

      Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.

    • namestring

      Name of the field.

    • tagsarray of strings

      Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.

    • commentstring

      Field comment.

    • cardinalinteger

      Number of distinct field values.

      format = int32

    • byte_sizeinteger

      Static RAM memory used in bytes.

      format = int64

    • is_hiddenboolean

      If set to true, the field is hidden. The default value is false.

    • is_lockedboolean

      If set to true, the field is locked. The default value is false.

    • is_systemboolean

      If set to true, the field is a system field. The default value is false.

    • is_numericboolean

      Is set to true if the value is a numeric. The default value is false.

    • src_tablesarray of strings

      List of table names.

    • is_semanticboolean

      If set to true, the field is semantic. The default value is false.

    • total_countinteger

      Total number of field values.

      format = int64

    • distinct_onlyboolean

      If set to true, only distinct field values are shown. The default value is false.

    • always_one_selectedboolean

      If set to true, the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.

  • tablesarray of objects

    List of table descriptions.

    Show tables properties

    • namestring

      Name of the table.

    • commentstring

      Table comment.

    • is_looseboolean

      If set to true, the table is loose due to circular connection. The default value is false.

    • byte_sizeinteger

      Static RAM memory used in bytes.

      format = int64

    • is_systemboolean

      If set to true, the table is a system table. The default value is false.

    • no_of_rowsinteger

      Number of rows.

      format = int64

    • is_semanticboolean

      If set to true, the table is semantic. The default value is false.

    • no_of_fieldsinteger

      Number of fields.

      format = int32

    • no_of_key_fieldsinteger

      Number of key fields.

      format = int32

  • reload_metaobject
    Show reload_meta properties

    • hardwareobject
      Show hardware properties

      • total_memoryinteger

        RAM available.

        format = int64

      • logical_coresinteger

        Number of logical cores available.

        format = int32

    • cpu_time_spent_msinteger

      Number of CPU milliseconds it took to reload the app.

      format = int64

    • peak_memory_bytesinteger

      Maximum number of bytes used during reload of the app.

      format = int64

    • fullReloadPeakMemoryBytesinteger

      Maximum number of bytes used during full reload of the app.

      format = int64

    • partialReloadPeakMemoryBytesinteger

      Maximum number of bytes used during partial reload of the app.

      format = int64

  • static_byte_sizeinteger

    Static memory usage for the app.

    format = int64

  • has_section_accessboolean

    If set to true, the app has section access configured.

  • is_direct_query_modeboolean
  • tables_profiling_dataarray of objects

    Profiling data of the tables in the app.

    Show tables_profiling_data properties

    • NoOfRowsinteger

      Number of rows in the table.

      format = int64

    • FieldProfilingarray of objects

      Field values profiling info

      Show FieldProfiling properties

      • Maxnumber

        Maximum value of numerical values. NaN otherwise.

        format = double

      • Minnumber

        Minimum value of numerical values. NaN otherwise.

        format = double

      • Stdnumber

        Standard deviation of numerical values. NaN otherwise.

        format = double

      • Sumnumber

        Sum of all numerical values. NaN otherwise.

        format = double

      • Namestring

        Name of the field.

      • Sum2number

        Squared sum of all numerical values. NaN otherwise.

        format = double

      • Mediannumber

        Median of all numerical values. NaN otherwise.

        format = double

      • Averagenumber

        Average of all numerical values. NaN otherwise.

        format = double

      • Kurtosisnumber

        Kurtosis of the numerical values. NaN otherwise.

        format = double

      • Skewnessnumber

        Skewness of the numerical values. NaN otherwise.

        format = double

      • FieldTagsarray of strings

        List of tags related to the field.

      • Fractilesarray of numbers

        The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

      • NegValuesinteger

        Number of negative values

        format = int64

      • PosValuesinteger

        Number of positive values

        format = int64

      • LastSortedstring

        For textual values the last sorted string.

      • NullValuesinteger

        Number of null values

        format = int64

      • TextValuesinteger

        Number of textual values

        format = int64

      • ZeroValuesinteger

        Number of zero values for numerical values

        format = int64

      • FirstSortedstring

        For textual values the first sorted string.

      • AvgStringLennumber

        Average string length of textual values. 0 otherwise.

        format = double

      • EmptyStringsinteger

        Number of empty strings

        format = int64

      • MaxStringLeninteger

        Maximum string length of textual values. 0 otherwise.

        format = int64

      • MinStringLeninteger

        Minimum string length of textual values. 0 otherwise.

        format = int64

      • MostFrequentarray of objects

        Three most frequent values and their frequencies

        Show MostFrequent properties

        • Symbolobject
          Show Symbol properties

          • Textstring

            String value of the symbol. This parameter is optional and present only if Symbol is a string.

          • Numbernumber

            Numeric value of the symbol. NaN otherwise.

            format = double

        • Frequencyinteger

          Frequency of the above symbol in the field

          format = int64

      • NumberFormatobject

        Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.

        Formatting mechanism

        The formatting mechanism depends on the type set in qType, as shown below:

        In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.

        Type is DATE, TIME, TIMESTAMP or INTERVAL

        The following applies:

        • If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
        • If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
        • The properties qDec , qThou , qnDec , qUseThou are not used.

        Type is INTEGER

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .

        Type is REAL

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
        • If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
        • If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is FIX

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
        • If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.

        Type is MONEY

        The following applies:

        • If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
        • If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).

        Type is ASCII

        No formatting, qFmt is ignored.

        Show NumberFormat properties

        • Decstring

          Defines the decimal separator. Example: .

        • Fmtstring

          Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date.

        • Thoustring

          Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,

        • Typestring

          Can be one of: "U""A""I""R""F""M""D""T""TS""IV"

        • nDecinteger

          Number of decimals. Default is 10.

          default = 10, format = int32, default = 10

        • UseThouinteger

          Defines whether or not a thousands separator must be used. Default is 0.

          default = 0, format = int32, default = 0

      • SumStringLeninteger

        Sum of all characters in strings in the field

        format = int64

      • NumericValuesinteger

        Number of numeric values

        format = int64

      • DistinctValuesinteger

        Number of distinct values

        format = int64

      • DistinctTextValuesinteger

        Number of distinct text values

        format = int64

      • DistinctNumericValuesinteger

        Number of distinct numeric values

        format = int64

      • FrequencyDistributionobject
        Show FrequencyDistribution properties

        • BinsEdgesarray of numbers

          Bins edges.

        • Frequenciesarray of integers

          Bins frequencies.

        • NumberOfBinsinteger

          Number of bins.

          format = int32

• application/jsonobject
  Show application/json properties

  • dataarray of objects
    Show data properties

    • idstring
    • compositionsarray of objects
      Show compositions properties

      • dimsobject

        Upper and lower bounds for items of specific classification types

        Show dims properties

        • maxnumber
        • minnumber
      • geosobject

        Upper and lower bounds for items of specific classification types

        Show geos properties

        • maxnumber
        • minnumber
      • msrsobject

        Upper and lower bounds for items of specific classification types

        Show msrs properties

        • maxnumber
        • minnumber
      • itemsobject

        Upper and lower bounds for items of specific classification types

        Show items properties

        • maxnumber
        • minnumber
      • temporalsobject

        Upper and lower bounds for items of specific classification types

        Show temporals properties

        • maxnumber
        • minnumber
      • descriptionobject
        Show description properties

        • longstring
        • shortstring
    • supportsMasterItemsboolean

      If analysis can work with master items (default is true)

    • requiresAutoCalendarPeriodboolean

      Used for period-specific analyses to indicate the defined or available calendar period must be of type autoCalendar

    • requiresDefinedAnalysisPeriodboolean

      Used for period-specific analyses to indicate the measure must be associated with one or more analysis periods

    • requiresAvailableAnalysisPeriodboolean

      Used for period-specific analyses to indicate the temporal dimension must be associated with one or more analysis periods

  • linksobject
    Show links properties

    • nextobject
      Show next properties

      • hrefstring

        format = "uri"

    • prevobject
      Show prev properties

      • hrefstring

        format = "uri"

    • selfobject
      Show self properties

      • hrefstring

        format = "uri"

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples: ``` { 'text': 'show me sales by product' } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { libId: 'NwQfJ' } ] } ``` ``` { 'fields': [ { 'name': 'product' } ], 'libItems': [ { 'libId': 'NwQfJ' } ], 'targetAnalysis': { 'id': 'rank-rank' } } ```

• application/jsonobject

  Request payload can be of two types, using natural language query or consist of fields or master items and optional target analysis. In below examples, consider sales as a master item and product as field, so to get recommendations using sales and product, you can utilize below three approaches, also you can set language parameter in headers as part of accept-language. Examples:

  {
    'text': 'show me sales by product'
  }
  

  {
    'fields': [
      {
        'name': 'product'
      }
    ],
    'libItems': [
      {
        libId: 'NwQfJ'
      }
    ]
  }
  

  {
    'fields': [
      {
        'name': 'product'
      }
    ],
    'libItems': [
      {
        'libId': 'NwQfJ'
      }
    ],
    'targetAnalysis': {
      'id': 'rank-rank'
    }
  }
  

  One of:

  • RecommendNaturalLangQueryobject
    Show RecommendNaturalLangQuery properties

    • textstring

      Required

      The NL query.

  • RecommendItemsobject
    Show RecommendItems properties

    • fieldsarray of objects

      structure for providing fields in recommendation request, user can retrieve the fields using insight-analyses/model endpoint

      Show fields properties

      • namestring
      • overridesobject
        Show overrides properties

        • classificationsarray of strings
        • defaultAggregationstring
    • libItemsarray of objects

      structure for providing master items in recommendation request, user can retrieve the libId of master item using insight-analyses/model endpoint

      Show libItems properties

      • libIdstring
      • overridesobject
        Show overrides properties

        • formatobject
          Show format properties

          • qDecstring
          • qFmtstring
          • qThoustring
          • qTypestring
          • qnDecnumber
          • qUseThounumber
    • targetAnalysisobject
      Show targetAnalysis properties

      • idstring

        id of the target analysis, returned by the GET insight-analyses endpoint

• application/jsonobject
  Show application/json properties

  • dataarray of objects
    Show data properties

    • nluInfoarray of objects

      Contains break down of the asked question in the form of tokens with their classification.

      Show nluInfo properties

      • rolestring

        Role of the token or phrase from query

        Can be one of: "dimension""measure""date"

      • textstring

        Matching token or phrase from query

      • typestring

        Type of token from query

        Can be one of: "field""filter""master_dimension""master_measure""custom_analysis"

      • fieldNamestring

        Qlik sense application field selected for given token or phrase

      • fieldValuestring

        Filter value found from query

    • recAnalysesarray of objects

      Required
      Show recAnalyses properties

      • optionsobject

        (chart options + hypercube definition)

      • analysisobject
        Show analysis properties

        • titlestring
        • analysisstring

          Can be one of: "breakdown""changePoint""comparison""contribution""correlation""fact""mutualInfo""rank""spike""trend""values"

        • analysisGroupstring

          Can be one of: "anomaly""brekadown""comparison""correl""fact""list""mutualInfo""rank"

      • chartTypestring

        Chart type given to current recommendation

        Can be one of: "barchart""combochart""distributionplot""kpi""linechart""map""scatterplot""table"

      • relevancenumber

        percentage of selected items in the analysis to the overall items passed to the endpoint

      • partsarray of objects

        part analyses (only for macro analyses)

        Show parts properties

        • optionsobject

          (chart options + hypercube definition)

        • analysisobject
          Show analysis properties

          • titlestring
          • analysisstring

            Can be one of: "breakdown""changePoint""comparison""contribution""correlation""fact""mutualInfo""rank""spike""trend""values"

          • analysisGroupstring

            Can be one of: "anomaly""brekadown""comparison""correl""fact""list""mutualInfo""rank"

        • chartTypestring

          Chart type given to current recommendation

          Can be one of: "barchart""combochart""distributionplot""kpi""linechart""map""scatterplot""table"

        • relevancenumber

          percentage of selected items in the analysis to the overall items passed to the endpoint

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • dataarray of objects
    Show data properties

    • fieldsarray of objects
      Show fields properties

      • namestring

        populated only for fields

      • isHiddenboolean

        whether the field is hidden in business logic

        default = false

      • classificationsarray of strings

        classification defines the default role that attribute can play in an analysis

        Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"

      • simplifiedClassificationsarray of strings

        Values may be any of: "dimension""measure""temporal""geographical"

    • masterItemsarray of objects
      Show masterItems properties

      • libIdstring

        only available for master items

      • captionstring
      • isHiddenboolean

        whether the master item is hidden in business logic

        default = false

      • classificationsarray of strings

        classification defines the default role that attribute can play in an analysis

        Values may be any of: "dimension""measure""temporal""city""address""boolean""country""date""email""geographical""geoPoint""geoPolygon""hour""latitude""monetary""ordinal""percentage""postalCode""quarter""stateProvince""timestamp""week""weekDay""year""yearDay"

      • simplifiedClassificationsarray of strings

        Values may be any of: "dimension""measure""temporal""geographical"

    • isLogicalModelEnabledboolean

      if the analysis model is constructed based on a user-defined business-logic (as opposed to a default one)

    • isDefinedLogicalModelValidboolean

      set only if previous property is true, to indicate if the business logic passes validation

  • linksobject
    Show links properties

    • nextobject
      Show next properties

      • hrefstring

        format = "uri"

    • prevobject
      Show prev properties

      • hrefstring

        format = "uri"

    • selfobject
      Show self properties

      • hrefstring

        format = "uri"

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.

• application/jsonobject
  Show application/json properties

  • errorsarray of objects

    An error object.

    Show errors properties

    • codestring

      Required

      The error code.

    • metaobject

      Additional properties relating to the error.

    • titlestring

      Required

      Summary of the problem.

    • detailstring

      A human-readable explanation specific to this occurrence of the problem.

    • sourceobject

      References to the source of the error.

      Show source properties

      • pointerstring

        A JSON Pointer to the property that caused the error.

      • parameterstring

        The URI query parameter that caused the error.