executeQuery

Executes a CRM Analytics query written in Salesforce Analytics Query Language (SAQL) or standard SQL.

Syntax 

1import { LightningElement, wire } from 'lwc';
2import { executeQuery } from 'lightning/analyticsWaveApi';
3
4export default class ExecuteQuery extends LightningElement {
5  query = '<YOUR SAQL QUERY>'; // or generate SAQL for dynamic query
6
7  get computedQuery() {
8    if (!this.query) { return undefined; }
9      return {
10        query: this.query;
11      }
12  }
13
14  @wire(executeQuery, {
15    query: '$computedQuery'
16  })
17  onExecuteQuery({data, error}) {
18    if (error) {
19      console.log(`executeQuery(${computedQuery}) ERROR:`, error);
20    } else if (data) {
21      console.log('executeQuery results RESPONSE:', data.results.records);
22      console.log('executeQuery metadata RESPONSE:', data.results.metadata);
23    }
24  }
25}

CRM Analytics API Resource 

1POST /wave/query

executeQuery uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
queryStringThe query string to execute.Yes
queryLanguageStringThe query language. The default is SAQL.
  • SAQL
  • SQL
timeZoneStringThe timezone for the query.

Returns 

See Also