Application Framework Reference

Splunk API

getScanCount()

The getScanCount() method gets the number of events scanned by the current job in compiling the event or result set.

Synopsis

count = getScanCount()

Return Value

Integer

Number of scanned events.

Example

var context = this.getContext();
var search = context.get('search');
console.log('Scan count = ' + search.job.getScanCount().toString());
 

See Also

getEventAvailableCount()
getEventCount()
getResultCount()