Reports

Note

precision needs to be one of ‘HOURLY’, ‘DAILY’, or ‘MONTHLY’. start_date and end_date must be datetime.datetime objects.

class urbanairship.reports.IndividualResponseStats(airship: BaseClient): Returns detailed reports information about a specific push notification.

class urbanairship.reports.ResponseList(airship: BaseClient, start_date: datetime, end_date: datetime, limit: str | None = None, start_id: str | None = None): Get a listing of all pushes, plus basic response information, in a given timeframe. Start and end date times are required parameters.

class urbanairship.reports.DevicesReport(airship: BaseClient): Returns a project’s opted-in and installed device counts broken out by device type as a daily snapshot. This endpoint returns the same data that populates the Devices Report on the web dashboard.

class urbanairship.reports.OptInList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the number of opted-in Push users who access the app within the specified time period.

class urbanairship.reports.OptOutList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the number of opted-out Push users who access the app within the specified time period

class urbanairship.reports.PushList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the number of pushes you have sent within a specified time period.

class urbanairship.reports.ResponseReportList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the number of direct and influenced opens of your app.

class urbanairship.reports.AppOpensList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the number of users who have opened your app within the specified time period.

class urbanairship.reports.TimeInAppList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the average amount of time users have spent in your app within the specified time period.

class urbanairship.reports.CustomEventsList(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get a summary of custom event counts and values, by custom event, within the specified time period.

class urbanairship.reports.WebResponseReport(airship: BaseClient, start_date: datetime, end_date: datetime, precision: str): Get the web interaction data for the given app key. Accepts a required start time and optional end time and precision parameters.

class urbanairship.reports.experiments.ExperimentReport(airship: BaseClient)

Access reporting related to A/B Tests (experiments)

get_overview(push_id: str) → Dict[str, Any]

Returns statistics and metadata about an experiment (A/B Test).

Parameters:: push_id – A UUID representing an A/B test of the requested experiment.
Returns:: JSON from the API

get_variant(push_id: str, variant_id: str) → Dict[str, Any]

Returns statistics and metadata about a specific variant in an experiment (A/B Test).

Parameters:

Returns:

JSON from the API