Close httplib2 connections.
Get a report with its computed results.
Retrieves the next page of results.
List all of the available reports.
close()
Close httplib2 connections.
get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, pageSize=None, pageToken=None, x__xgafv=None)
Get a report with its computed results.
Args:
name: string, Required. The report name. Format: "projects/{project}/apps/{app_id}/reports/{report}". (required)
filter_browser_displayNames: string, Optional. Only count events from the given browser. This string matches Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or just "name" for all possible versions, e.g. simply "Chrome". (repeated)
filter_device_displayNames: string, Only counts events from the given Device model. This string matches Device.display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "manufacturer" for all possible models, e.g. simply "Google". Note that a device's marketing_name field can not be used for filtering. (repeated)
filter_device_formFactors: string, Only counts events from devices with the given form factor (e.g. phone or tablet). (repeated)
Allowed values
FORM_FACTOR_UNSPECIFIED - Unknown.
PHONE - Includes mobile phones, small foldables and other form factors not fitting the other categories.
TABLET - Includes tablets and larger foldables.
DESKTOP - Includes desktops, laptops, Chromebooks, etc.
TV - Includes televisions and set-tops.
WATCH - Includes both watches and other wearables.
filter_interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
filter_interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
filter_issue_content: string, Optional. A space separated list of filter terms matched against the contents of the issue. Contents include the title and the stack trace. Matches must begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet' but not 'myutil.SortedArray'. The filter matches if all filter terms match. All non-alphanumeric characters are ignored for matching. Filtering is assumed to be prefix-search and order-independent unless phrases are surrounded by "". Any terms contained in quotes are searched using exact-match (given filter term "foo", we will not return "foobar"), and must appear in the order given exactly. To get order-dependence but prefix-search, use a * within the quotes ("abc foo*" will match "abc foobar", but not "foo abc" "abcd foobar", or "abc xyz foobar").
filter_issue_errorTypes: string, Optional. Only counts events of the given error types. This field matches [Issue.error_type]. (repeated)
Allowed values
ERROR_TYPE_UNSPECIFIED - Unknown.
FATAL - Fatal crash event.
NON_FATAL - Non-fatal event, such as a caught Java exception or NSError on iOS.
ANR - Application not responding error, Android only.
filter_issue_id: string, Optional. Only counts events in the given issue ID. This field matches [Issue.id].
filter_issue_signals: string, Optional. Only returns issues currently marked with the given signals. This field matches [Issue.signals.signal]. (repeated)
Allowed values
SIGNAL_UNSPECIFIED - Default.
SIGNAL_EARLY - Indicates an issue that is impacting end users early in the app session.
SIGNAL_FRESH - Indicates newly detected issues.
SIGNAL_REGRESSED - Indicates previously closed issues which have been detected again.
SIGNAL_REPETITIVE - Indicates issues impacting some end users multiple times.
filter_issue_state: string, Optional. Deprecated: Prefer `states` field. Only includes events for issues with the given issue state. Only available for `topIssues` reports.
Allowed values
STATE_UNSPECIFIED - Unknown.
OPEN - Ongoing issue.
CLOSED - Issue resolved.
MUTED - Issue muted. No alerts will be fired for this issue.
filter_issue_states: string, Optional. Only includes events for issues with the given issue states. Only available for `topIssues` reports. (repeated)
Allowed values
STATE_UNSPECIFIED - Unknown.
OPEN - Ongoing issue.
CLOSED - Issue resolved.
MUTED - Issue muted. No alerts will be fired for this issue.
filter_issue_variantId: string, Optional. Only counts events for the given issue variant ID. This field matches [IssueVariant.id].
filter_operatingSystem_displayNames: string, Only counts events in the given operating system and version. This string matches OperatingSystem.display_name. Format: "osName (osVersion)" e.g. "Android (11)". or just "osName" for all versions, e.g. simply "iPadOS". (repeated)
filter_version_displayNames: string, Only counts events in the given app version. This string matches Version.display_name. Format: "display_version (build_version)" e.g. "1.2.3 (456)". (repeated)
granularity: string, Optional. The report response will contain one data point per time grain. If omitted, the report will contain a single data point for the complete interval.
Allowed values
TIME_GRANULARITY_UNSPECIFIED - Unknown.
TIME_GRANULARITY_NONE - Returns a single interval for the requested time range.
TIME_GRANULARITY_HOUR - Hour.
TIME_GRANULARITY_DAY - Day.
pageSize: integer, Optional. The maximum number of result groups to return. If omitted, defaults to 25.
pageToken: string, Optional. A page token, received from a previous call. The page token is only valid for the exact same set of filters, which must also be sent in subsequent requests. This token is valid for 10 minutes after the first request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the GetReport method. A report consists of the results of a query over an application's events. The events may be filtered by various criteria defined in the filters proto. The result will consist of a number of paginated groups, of a type relevant to the report such as issues or device models.
"displayName": "A String", # Output only. The displayable title of the report.
"groups": [ # Aggregate event statistics in the report will be grouped by a dimension, such as by issue or by version. The response contains one element per group, and all ReportGroup messages will have the same parent field.
{ # A group of results in an EventReport. In any report, the group_parent field is strictly the same type for all of the groups in any collection.
"browser": { # Web browser metadata. # Browser metrics group.
"browser": "A String", # Browser name.
"displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
"displayVersion": "A String", # Browser display version number.
},
"device": { # Mobile device metadata. # Device metrics group.
"architecture": "A String", # Device processor architecture.
"companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
"displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
"formFactor": "A String", # See FormFactor message.
"manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
"marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
"model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
},
"issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Issue metrics group.
"errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
"firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
"firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
"id": "A String", # Output only. Immutable. Unique identifier for the issue.
"lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
"lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
"name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
"notesCount": "A String", # Output only. The number of notes attached to an issue.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
"signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
{ # Distinctive characteristics assigned by the Crashlytics analyzer.
"description": "A String", # Output only. Supporting detail information.
"signal": "A String", # Output only. The signal name.
},
],
"state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
"stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
"subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
"title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
"uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
"variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
{ # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
"id": "A String", # Output only. Immutable. Distinct identifier for the variant.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
"uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
},
],
},
"metrics": [ # Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.
{ # A set of computed metric values for a time interval
"endTime": "A String", # The end of the interval covered by the computation.
"eventsCount": "A String", # The total count of events in the interval.
"impactedUsersCount": "A String", # The number of distinct users in the set of events.
"sessionsCount": "A String", # The number of distinct sessions in the set of events.
"startTime": "A String", # The start of the interval covered by the computation.
},
],
"operatingSystem": { # Mobile device operating system metadata. # Operating system metrics group.
"deviceType": "A String", # The device category (mobile, tablet, desktop).
"displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
"displayVersion": "A String", # Operating system display version number.
"modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
"os": "A String", # Operating system name.
"type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
},
"subgroups": [ # When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.
# Object with schema name: ReportGroup
],
"variant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Issue variant metrics group.
"id": "A String", # Output only. Immutable. Distinct identifier for the variant.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
"uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
},
"version": { # Application software version. # Version metrics group.
"buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
"displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
"displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
"tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
{ # Describes a release track in the Play Developer Console.
"title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
"type": "A String", # The type of track (prod, internal, etc...).
},
],
},
"webMetricsGroup": { # Represents a grouping for metrics specific to web applications. # Web metrics group.
"id": "A String", # The id of the web metrics group
},
},
],
"name": "A String", # The name of the report. Format: "projects/{project}/apps/{app_id}/reports/{report}".
"nextPageToken": "A String", # Output only. A page token used to retrieve additional report groups. If this field is not present, there are no subsequent pages available to retrieve.
"totalSize": 42, # Output only. The total number of groups retrievable by the request.
"usage": "A String", # Usage instructions for the report with a description of the result metrics. This field contains a description of the underlying query and describes the expected response data with any known caveats. This string can be displayed in the UI of any integration that offers comprehensive access to all Crashlytics reports.
}
get_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
list(parent, x__xgafv=None)
List all of the available reports.
Args:
parent: string, Required. The firebase application. Format: "projects/{project}/apps/{app_id}". (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response method for the ListReports method. The response will always include all of the available reports.
"reports": [ # The report objects returned will contain their names and usage instructions, but include no results. Use the `GetReport` method to run the report and obtain the paged results.
{ # Response message for the GetReport method. A report consists of the results of a query over an application's events. The events may be filtered by various criteria defined in the filters proto. The result will consist of a number of paginated groups, of a type relevant to the report such as issues or device models.
"displayName": "A String", # Output only. The displayable title of the report.
"groups": [ # Aggregate event statistics in the report will be grouped by a dimension, such as by issue or by version. The response contains one element per group, and all ReportGroup messages will have the same parent field.
{ # A group of results in an EventReport. In any report, the group_parent field is strictly the same type for all of the groups in any collection.
"browser": { # Web browser metadata. # Browser metrics group.
"browser": "A String", # Browser name.
"displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
"displayVersion": "A String", # Browser display version number.
},
"device": { # Mobile device metadata. # Device metrics group.
"architecture": "A String", # Device processor architecture.
"companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
"displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
"formFactor": "A String", # See FormFactor message.
"manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
"marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
"model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
},
"issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Issue metrics group.
"errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
"firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
"firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
"id": "A String", # Output only. Immutable. Unique identifier for the issue.
"lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
"lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
"name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
"notesCount": "A String", # Output only. The number of notes attached to an issue.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
"signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
{ # Distinctive characteristics assigned by the Crashlytics analyzer.
"description": "A String", # Output only. Supporting detail information.
"signal": "A String", # Output only. The signal name.
},
],
"state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
"stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
"subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
"title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
"uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
"variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
{ # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
"id": "A String", # Output only. Immutable. Distinct identifier for the variant.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
"uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
},
],
},
"metrics": [ # Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.
{ # A set of computed metric values for a time interval
"endTime": "A String", # The end of the interval covered by the computation.
"eventsCount": "A String", # The total count of events in the interval.
"impactedUsersCount": "A String", # The number of distinct users in the set of events.
"sessionsCount": "A String", # The number of distinct sessions in the set of events.
"startTime": "A String", # The start of the interval covered by the computation.
},
],
"operatingSystem": { # Mobile device operating system metadata. # Operating system metrics group.
"deviceType": "A String", # The device category (mobile, tablet, desktop).
"displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
"displayVersion": "A String", # Operating system display version number.
"modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
"os": "A String", # Operating system name.
"type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
},
"subgroups": [ # When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.
# Object with schema name: ReportGroup
],
"variant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Issue variant metrics group.
"id": "A String", # Output only. Immutable. Distinct identifier for the variant.
"sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
"uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
},
"version": { # Application software version. # Version metrics group.
"buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
"displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
"displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
"tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
{ # Describes a release track in the Play Developer Console.
"title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
"type": "A String", # The type of track (prod, internal, etc...).
},
],
},
"webMetricsGroup": { # Represents a grouping for metrics specific to web applications. # Web metrics group.
"id": "A String", # The id of the web metrics group
},
},
],
"name": "A String", # The name of the report. Format: "projects/{project}/apps/{app_id}/reports/{report}".
"nextPageToken": "A String", # Output only. A page token used to retrieve additional report groups. If this field is not present, there are no subsequent pages available to retrieve.
"totalSize": 42, # Output only. The total number of groups retrievable by the request.
"usage": "A String", # Usage instructions for the report with a description of the result metrics. This field contains a description of the underlying query and describes the expected response data with any known caveats. This string can be displayed in the UI of any integration that offers comprehensive access to all Crashlytics reports.
},
],
}