get_list_data_view

Retrieve, filter, sort, and aggregate list-type data views using advanced querying capabilities. Supports standard data retrieval, grouped aggregates, distinct values, and non-queryable data views for efficient data management.

Instructions

Retrieve list type data view with advanced querying capabilities. Supports 4 distinct use cases:

Standard Data Retrieval: Get data with pagination, filtering, and sorting Example: { "dataViewID": "D_Employees", "query": { "select": [{"field": "Name"}, {"field": "Age"}], "filter": { "filterConditions": { "F1": { "lhs": {"field": "Department"}, "comparator": "EQ", "rhs": {"value": "IT"} } }, "logic": "F1" } }, "paging": { "pageSize": 100 } }
Aggregated Data: Get aggregated data with optional grouping Example: { "dataViewID": "D_Employees", "query": { "aggregations": { "AvgAge": { "field": "age", "summaryFunction": "AVG" } }, "select": [{"field": "Department"}] }, "paging": { "maxResultsToFetch": 2000 } }
Distinct Values: Get unique values from filtered lists Example: { "dataViewID": "D_Employees", "query": { "select": [{"field": "Department"}], "distinctResultsOnly": true }, "paging": { "maxResultsToFetch": 1000 } }
Non-queryable Data Views: Simple data retrieval without querying Example: { "dataViewID": "D_SimpleData", "dataViewParameters": { "param1": "value1", "param2": "value2" } }

Filter comparators supported: boolean (IS_TRUE, IS_FALSE, IS_NULL, IS_NOT_NULL, EQ, NEQ), string (EQ, NEQ, IN, NOT_IN, IS_NULL, IS_NOT_NULL, STARTS_WITH, NOT_STARTS_WITH, ENDS_WITH, NOT_ENDS_WITH, CONTAINS, NOT_CONTAINS), number/date (EQ, NEQ, IN, NOT_IN, GT, GTE, LT, LTE, ISNULL, ISNOTNULL).

Aggregation functions: COUNT, MAX, MIN, DISTINCT_COUNT. For numbers: SUM, AVG.

Input Schema

Name	Required	Description
`dataViewID`	Yes	ID of the data view to retrieve data from. Must be a valid data view identifier that exists in the Pega system. Example: "D_Employees", "D_CustomerList"
`dataViewParameters`	No	Optional parameters for the data view if it has mandatory parameters. Key-value pairs where keys are parameter names and values are parameter values. Example: {"param1": "value1", "param2": "value2"}
`paging`	No	Optional pagination configuration. Can specify either maxResultsToFetch or pageNumber/pageSize combination, but not both.
`query`	No	Optional query object for filtering, sorting, aggregation, and field selection. If not specified, retrieves data as a regular data view.
`useExtendedTimeout`	No	Optional flag that works only if the data view is sourced by a report definition. When set to true, increases timeout to 45 seconds. Otherwise, timeout is 10 seconds.

Input Schema (JSON Schema)

{
  "properties": {
    "dataViewID": {
      "description": "ID of the data view to retrieve data from. Must be a valid data view identifier that exists in the Pega system. Example: \"D_Employees\", \"D_CustomerList\"",
      "type": "string"
    },
    "dataViewParameters": {
      "description": "Optional parameters for the data view if it has mandatory parameters. Key-value pairs where keys are parameter names and values are parameter values. Example: {\"param1\": \"value1\", \"param2\": \"value2\"}",
      "type": "object"
    },
    "paging": {
      "description": "Optional pagination configuration. Can specify either maxResultsToFetch or pageNumber/pageSize combination, but not both.",
      "properties": {
        "maxResultsToFetch": {
          "description": "Maximum number of results to fetch when data is not paginated. Default and maximum value is 5000. Cannot be used with pageNumber/pageSize.",
          "maximum": 5000,
          "minimum": 1,
          "type": "integer"
        },
        "pageNumber": {
          "default": 1,
          "description": "Page number to retrieve (1-based). Use with pageSize. Cannot be used with maxResultsToFetch.",
          "minimum": 1,
          "type": "integer"
        },
        "pageSize": {
          "default": 100,
          "description": "Number of records per page. Maximum value is 5000. Use with pageNumber. Cannot be used with maxResultsToFetch.",
          "maximum": 5000,
          "minimum": 1,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "query": {
      "description": "Optional query object for filtering, sorting, aggregation, and field selection. If not specified, retrieves data as a regular data view.",
      "properties": {
        "aggregations": {
          "description": "Object containing aggregation definitions. Each key is a unique name for the aggregation, each value contains field and summaryFunction. Example: {\"AverageAge\": {\"field\": \"age\", \"summaryFunction\": \"AVG\"}, \"EmployeeCount\": {\"field\": \"EmployeeID\", \"summaryFunction\": \"COUNT\"}}",
          "type": "object"
        },
        "distinctResultsOnly": {
          "default": false,
          "description": "Set to true to return distinct set of results only. Cannot be specified with aggregation. Use with select fields to get unique combinations.",
          "type": "boolean"
        },
        "filter": {
          "description": "Complex filtering conditions with support for multiple comparators and logical operators.",
          "properties": {
            "filterConditions": {
              "description": "Object containing filter conditions. Each key (F1, F2, etc.) represents a condition with lhs (left-hand side), comparator, and rhs (right-hand side). Example: {\"F1\": {\"ignoreCase\": true, \"lhs\": {\"field\": \"firstname\"}, \"comparator\": \"EQ\", \"rhs\": {\"value\": \"abc\"}}, \"F2\": {\"lhs\": {\"field\": \"IsRetired\"}, \"comparator\": \"IS_TRUE\"}}",
              "type": "object"
            },
            "logic": {
              "default": "AND",
              "description": "Logical expression combining filter conditions using AND/OR operators. Supports parentheses. Examples: \"F1\", \"F1 AND F2\", \"(F1 AND F2) OR (F3 AND F4)\". Default is AND.",
              "type": "string"
            }
          },
          "type": "object"
        },
        "select": {
          "description": "Array of field objects to select. Each object should have a \"field\" property. Example: [{\"field\": \"Name\"}, {\"field\": \"Age\"}, {\"field\": \"DOB\"}]",
          "items": {
            "properties": {
              "field": {
                "description": "Field name to select",
                "type": "string"
              }
            },
            "required": [
              "field"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "sortBy": {
          "description": "Array of sorting configurations. Each object can specify field name with type (ASC/DESC) or aggregation name with type. Example: [{\"field\": \"Name\", \"type\": \"ASC\"}, {\"aggregation\": \"AverageAge\", \"type\": \"DESC\"}]",
          "items": {
            "properties": {
              "aggregation": {
                "description": "Aggregation name to sort by",
                "type": "string"
              },
              "field": {
                "description": "Field name to sort by",
                "type": "string"
              },
              "type": {
                "default": "ASC",
                "description": "Sort direction - ascending or descending",
                "enum": [
                  "ASC",
                  "DESC"
                ],
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "useExtendedTimeout": {
      "default": false,
      "description": "Optional flag that works only if the data view is sourced by a report definition. When set to true, increases timeout to 45 seconds. Otherwise, timeout is 10 seconds.",
      "type": "boolean"
    }
  },
  "required": [
    "dataViewID"
  ],
  "type": "object"
}

Pega DX MCP Server