REST Resource: projects.apps.reports

Resource: Report

Response message for the reports.get 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.

JSON representation 
{
  "groups": [
    {
      object (ReportGroup)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer,
  "name": string,
  "displayName": string,
  "usage": string
}
Fields
groups[]

object (ReportGroup)

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.
nextPageToken

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

integer

Output only. The total number of groups retrievable by the request.
name

string

The name of the report. Format: "projects/{project}/apps/{app_id}/reports/{report}".
displayName

string

Output only. The displayable title of the report.
usage

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.

ReportGroup

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.

JSON representation 
{
  "metrics": [
    {
      object (IntervalMetrics)
    }
  ],
  "subgroups": [
    {
      object (ReportGroup)
    }
  ],

  // Union field group_parent can be only one of the following:
  "issue": {
    object (Issue)
  },
  "variant": {
    object (IssueVariant)
  },
  "version": {
    object (Version)
  },
  "device": {
    object (Device)
  },
  "operatingSystem": {
    object (OperatingSystem)
  },
  "browser": {
    object (Browser)
  },
  "webMetricsGroup": {
    object (WebMetricsGroup)
  }
  // End of list of possible types for union field group_parent.
}
Fields
metrics[]

object (IntervalMetrics)

Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.
subgroups[]

object (ReportGroup)

When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.
Union field group_parent. The entity used to group the computed metrics. group_parent can be only one of the following:
issue

object (Issue)

Issue metrics group.
variant

object (IssueVariant)

Issue variant metrics group.
version

object (Version)

Version metrics group.
device

object (Device)

Device metrics group.
operatingSystem

object (OperatingSystem)

Operating system metrics group.
browser

object (Browser)

Browser metrics group.
webMetricsGroup

object (WebMetricsGroup)

Web metrics group.

Version

Application software version.

JSON representation 
{
  "displayVersion": string,
  "buildVersion": string,
  "displayName": string,
  "tracks": [
    {
      object (PlayTrack)
    }
  ]
}
Fields
displayVersion

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.
buildVersion

string

Mobile only. One displayVersion can have many buildVersion. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
displayName

string

Compound readable string containing both display and build versions. Format: "displayVersion (buildVersion)" e.g. "1.2.3 (456)". This string can be used for filtering with the [VersionFilter.display_name][] field.
tracks[]

object (PlayTrack)

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.

PlayTrack

Describes a release track in the Play Developer Console.

JSON representation 
{
  "title": string,
  "type": enum (TrackType)
}
Fields
title

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

enum (TrackType)

The type of track (prod, internal, etc...).

TrackType

Enum type that describes the type of track.

Enums
TRACK_TYPE_UNSPECIFIED Unknown.
TRACK_TYPE_PROD Production.
TRACK_TYPE_INTERNAL Internal testing.
TRACK_TYPE_OPEN_TESTING Open testing.
TRACK_TYPE_CLOSED_TESTING Closed testing.
TRACK_TYPE_EARLY_ACCESS Early access.

Device

Mobile device metadata.

JSON representation 
{
  "manufacturer": string,
  "model": string,
  "architecture": string,
  "displayName": string,
  "companyName": string,
  "marketingName": string,
  "formFactor": enum (FormFactor)
}
Fields
manufacturer

string

Device brand name which is consistent with android.os.Build.BRAND.
model

string

The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
architecture

string

Device processor architecture.
displayName

string

Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
companyName

string

An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
marketingName

string

Marketing name, most recognizable public form, e.g. "Pixel 6".
formFactor

enum (FormFactor)

See FormFactor message.

FormFactor

Device form factor.

Enums
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.

OperatingSystem

Mobile device operating system metadata.

JSON representation 
{
  "displayVersion": string,
  "os": string,
  "modificationState": string,
  "type": string,
  "deviceType": string,
  "displayName": string
}
Fields
displayVersion

string

Operating system display version number.
os

string

Operating system name.
modificationState

string

Indicates if the OS has been modified or "jailbroken".
type

string

The OS type on Apple platforms (iOS, iPadOS, etc.).
deviceType

string

The device category (mobile, tablet, desktop).
displayName

string

Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.

Browser

Web browser metadata.

JSON representation 
{
  "displayVersion": string,
  "browser": string,
  "displayName": string
}
Fields
displayVersion

string

Browser display version number.
browser

string

Browser name.
displayName

string

Browser name and version number. Formatted to be suitable for passing to BrowserFilter.

WebMetricsGroup

Represents a grouping for metrics specific to web applications.

JSON representation 
{
  "id": string
}
Fields
id

string

The id of the web metrics group

IntervalMetrics

A set of computed metric values for a time interval

JSON representation 
{
  "startTime": string,
  "endTime": string,
  "eventsCount": string,
  "impactedUsersCount": string,
  "sessionsCount": string
}
Fields
startTime

string (Timestamp format)

The start of the interval covered by the computation.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

The end of the interval covered by the computation.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
eventsCount

string (Int64Value format)

The total count of events in the interval.
impactedUsersCount

string (Int64Value format)

The number of distinct users in the set of events.
sessionsCount

string (Int64Value format)

The number of distinct sessions in the set of events.

Methods

get

 Get a report with its computed results.

list

 List all of the available reports.