Function getAppReportFilters

  • List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.

    Parameters

    • appId: string

      Qlik Sense app identifier

    • query: {
          filter?: string;
          filterTypes: ("REP" | "SUB")[];
          limit?: number;
          page?: string;
          sort?: (
              | "+description"
              | "-description"
              | "+ownerId"
              | "-ownerId"
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
          )[];
      }

      an object with query parameters

      • Optionalfilter?: string

        The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive. The following fields support the co (contains) operator: name, description The following fields support the eq (equals) operator: ownerId Example: (name co "query1" or description co "query2") and ownerId eq "123"

      • filterTypes: ("REP" | "SUB")[]

        The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark.

      • Optionallimit?: number

        Limit the returned result set

      • Optionalpage?: string

        If present, the cursor that starts the page of data that is returned.

      • Optionalsort?: (
            | "+description"
            | "-description"
            | "+ownerId"
            | "-ownerId"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
        )[]

        Sorting parameters.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetAppReportFiltersHttpResponse>

    GetAppReportFiltersHttpError