This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Get Performance Data

Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery

Example Usage

List<List<Object>> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5);


self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)


// webdriver.io example
driver.getPerformanceData('my.app.package', 'cpuinfo', 5);

// wd example
await driver.getPerformanceData('my.app.package', 'cpuinfo', 5);


# ruby_lib example
get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10

# ruby_lib_core example
@driver.get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10


// Not supported

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android Espresso ?+ 1.9.0+ All
UiAutomator2 ?+ 1.6.0+ All
UiAutomator 4.3+ All All
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java All appium.github.io
Python None appium.github.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
C# None github.com

HTTP API Specifications

Endpoint

POST /session/:session_id/appium/getPerformanceData

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
packageName string The package name of the application
dataType string The type of system state which wants to read. It should be one of the supported performance data types.
dataReadTimeout number The number of attempts to read (optional)

Response

The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery (array<string>)

See Also