Skip to content

Most visited

Recently visited

navigation

UsageStatsManager

public final class UsageStatsManager
extends Object

java.lang.Object
   ↳ android.app.usage.UsageStatsManager


Provides access to device usage history and statistics. Usage data is aggregated into time intervals: days, weeks, months, and years.

When requesting usage data since a particular time, the request might look something like this:

 PAST                   REQUEST_TIME                    TODAY                   FUTURE
 ————————————————————————————||———————————————————————————¦-----------------------|
                        YEAR ||                           ¦                       |
 ————————————————————————————||———————————————————————————¦-----------------------|
  MONTH            |         ||                MONTH      ¦                       |
 ——————————————————|—————————||———————————————————————————¦-----------------------|
   |      WEEK     |     WEEK||    |     WEEK     |     WE¦EK     |      WEEK     |
 ————————————————————————————||———————————————————|———————¦-----------------------|
                             ||           |DAY|DAY|DAY|DAY¦DAY|DAY|DAY|DAY|DAY|DAY|
 ————————————————————————————||———————————————————————————¦-----------------------|
 
A request for data in the middle of a time interval will include that interval.

NOTE: This API requires the permission android.permission.PACKAGE_USAGE_STATS, which is a system-level permission and will not be granted to third-party apps. However, declaring the permission implies intention to use the API and the user of the device can grant permission through the Settings application.

Instances of this class must be obtained using Context.getSystemService(Class) with the argument UsageStatsManager.class or Context.getSystemService(String) with the argument Context.USAGE_STATS_SERVICE.

Summary

Constants

int INTERVAL_BEST

An interval type that will use the best fit interval for the given time range.

int INTERVAL_DAILY

An interval type that spans a day.

int INTERVAL_MONTHLY

An interval type that spans a month.

int INTERVAL_WEEKLY

An interval type that spans a week.

int INTERVAL_YEARLY

An interval type that spans a year.

Public methods

boolean isAppInactive(String packageName)

Returns whether the specified app is currently considered inactive.

Map<StringUsageStats> queryAndAggregateUsageStats(long beginTime, long endTime)

A convenience method that queries for all stats in the given range (using the best interval for that range), merges the resulting data, and keys it by package name.

List<ConfigurationStats> queryConfigurations(int intervalType, long beginTime, long endTime)

Gets the hardware configurations the device was in for the given time range, aggregated by the specified interval.

UsageEvents queryEvents(long beginTime, long endTime)

Query for events in the given time range.

List<UsageStats> queryUsageStats(int intervalType, long beginTime, long endTime)

Gets application usage stats for the given time range, aggregated by the specified interval.

Inherited methods

From class java.lang.Object

Constants

INTERVAL_BEST

added in API level 21
int INTERVAL_BEST

An interval type that will use the best fit interval for the given time range. See queryUsageStats(int, long, long).

Constant Value: 4 (0x00000004)

INTERVAL_DAILY

added in API level 21
int INTERVAL_DAILY

An interval type that spans a day. See queryUsageStats(int, long, long).

Constant Value: 0 (0x00000000)

INTERVAL_MONTHLY

added in API level 21
int INTERVAL_MONTHLY

An interval type that spans a month. See queryUsageStats(int, long, long).

Constant Value: 2 (0x00000002)

INTERVAL_WEEKLY

added in API level 21
int INTERVAL_WEEKLY

An interval type that spans a week. See queryUsageStats(int, long, long).

Constant Value: 1 (0x00000001)

INTERVAL_YEARLY

added in API level 21
int INTERVAL_YEARLY

An interval type that spans a year. See queryUsageStats(int, long, long).

Constant Value: 3 (0x00000003)

Public methods

isAppInactive

added in API level 23
boolean isAppInactive (String packageName)

Returns whether the specified app is currently considered inactive. This will be true if the app hasn't been used directly or indirectly for a period of time defined by the system. This could be of the order of several hours or days.

Parameters
packageName String: The package name of the app to query

Returns
boolean whether the app is currently considered inactive

queryAndAggregateUsageStats

added in API level 21
Map<StringUsageStats> queryAndAggregateUsageStats (long beginTime, 
                long endTime)

A convenience method that queries for all stats in the given range (using the best interval for that range), merges the resulting data, and keys it by package name. See queryUsageStats(int, long, long).

Parameters
beginTime long: The inclusive beginning of the range of stats to include in the results.

endTime long: The exclusive end of the range of stats to include in the results.

Returns
Map<StringUsageStats> A Map keyed by package name, or null if no stats are available.

queryConfigurations

added in API level 21
List<ConfigurationStats> queryConfigurations (int intervalType, 
                long beginTime, 
                long endTime)

Gets the hardware configurations the device was in for the given time range, aggregated by the specified interval. The results are ordered as in queryUsageStats(int, long, long).

Parameters
intervalType int: The time interval by which the stats are aggregated.

beginTime long: The inclusive beginning of the range of stats to include in the results.

endTime long: The exclusive end of the range of stats to include in the results.

Returns
List<ConfigurationStats> A list of ConfigurationStats or null if none are available.

queryEvents

added in API level 21
UsageEvents queryEvents (long beginTime, 
                long endTime)

Query for events in the given time range. Events are only kept by the system for a few days.

NOTE: The last few minutes of the event log will be truncated to prevent abuse by applications.

Parameters
beginTime long: The inclusive beginning of the range of events to include in the results.

endTime long: The exclusive end of the range of events to include in the results.

Returns
UsageEvents A UsageEvents.

queryUsageStats

added in API level 21
List<UsageStats> queryUsageStats (int intervalType, 
                long beginTime, 
                long endTime)

Gets application usage stats for the given time range, aggregated by the specified interval.

The returned list will contain a UsageStats object for each package that has data for an interval that is a subset of the time range given. To illustrate:

 intervalType = INTERVAL_YEARLY
 beginTime = 2013
 endTime = 2015 (exclusive)

 Results:
 2013 - com.example.alpha
 2013 - com.example.beta
 2014 - com.example.alpha
 2014 - com.example.beta
 2014 - com.example.charlie
 

Parameters
intervalType int: The time interval by which the stats are aggregated.

beginTime long: The inclusive beginning of the range of stats to include in the results.

endTime long: The exclusive end of the range of stats to include in the results.

Returns
List<UsageStats> A list of UsageStats or null if none are available.

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)