# Interface ExecutePivotQueryParams

Parameters for useExecutePivotQuery hook.

# Properties

# Control

# enabled

enabled?: boolean

Boolean flag to control if query is executed

If not specified, the default value is true

# Data Options

# columns

columns?: (Attribute | PivotAttribute)[]

Dimensions for the columns of the pivot table

# dataSource

dataSource?: DataSource

Data source the query is run against - e.g. Sample ECommerce

If not specified, the query will use the defaultDataSource specified in the parent Sisense Context.

# grandTotals

grandTotals?: PivotGrandTotals

Options for grand totals

# rows

rows?: (Attribute | PivotAttribute)[]

Dimensions for the rows of the pivot table

# values

values?: (Measure | PivotMeasure)[]

Measures for the values of the pivot table

# Filtering

# filters

filters?: Filter[] | FilterRelations

Filters that will slice query results

# highlights

highlights?: Filter[]

Highlight filters that will highlight results that pass filter criteria

# Other

# onBeforeQuery

onBeforeQuery?: (jaql) => any

Sync or async callback that allows to modify the JAQL payload before it is sent to the server.

Note: In React, wrap this function in useCallback hook to avoid triggering query execution on each render.

const onBeforeQuery = useCallback((jaql) => {
  // modify jaql here
  return jaql;
}, []);

# Parameters

Parameter	Type
`jaql`	`any`

# Returns

any