reports
Creates, updates, deletes, gets or lists a reports resource.
Overview
| Name | reports |
| Type | Resource |
| Id | firebase.firebasecrashlytics.reports |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
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. |
groups | array | 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 (int32) | Output only. The total number of groups retrievable by the request. |
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. |
| Name | Datatype | Description |
|---|---|---|
reports | array | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | projectsId, appsId, reportsId | filter.device.displayNames, filter.issue.signals, filter.issue.variantId, filter.issue.content, pageToken, filter.issue.states, filter.issue.state, filter.interval.endTime, filter.device.formFactors, granularity, filter.issue.errorTypes, filter.interval.startTime, filter.version.displayNames, filter.issue.id, filter.browser.displayNames, pageSize, filter.operatingSystem.displayNames | Get a report with its computed results. |
list | select | projectsId, appsId | List all of the available reports. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
appsId | string | |
projectsId | string | |
reportsId | string | |
filter.browser.displayNames | string | |
filter.device.displayNames | string | |
filter.device.formFactors | string | |
filter.interval.endTime | string (google-datetime) | |
filter.interval.startTime | string (google-datetime) | |
filter.issue.content | string | |
filter.issue.errorTypes | string | |
filter.issue.id | string | |
filter.issue.signals | string | |
filter.issue.state | string | |
filter.issue.states | string | |
filter.issue.variantId | string | |
filter.operatingSystem.displayNames | string | |
filter.version.displayNames | string | |
granularity | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT examples
- get
- list
Get a report with its computed results.
SELECT
name,
displayName,
groups,
nextPageToken,
totalSize,
usage
FROM firebase.firebasecrashlytics.reports
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND reportsId = '{{ reportsId }}' -- required
AND filter.device.displayNames = '{{ filter.device.displayNames }}'
AND filter.issue.signals = '{{ filter.issue.signals }}'
AND filter.issue.variantId = '{{ filter.issue.variantId }}'
AND filter.issue.content = '{{ filter.issue.content }}'
AND pageToken = '{{ pageToken }}'
AND filter.issue.states = '{{ filter.issue.states }}'
AND filter.issue.state = '{{ filter.issue.state }}'
AND filter.interval.endTime = '{{ filter.interval.endTime }}'
AND filter.device.formFactors = '{{ filter.device.formFactors }}'
AND granularity = '{{ granularity }}'
AND filter.issue.errorTypes = '{{ filter.issue.errorTypes }}'
AND filter.interval.startTime = '{{ filter.interval.startTime }}'
AND filter.version.displayNames = '{{ filter.version.displayNames }}'
AND filter.issue.id = '{{ filter.issue.id }}'
AND filter.browser.displayNames = '{{ filter.browser.displayNames }}'
AND pageSize = '{{ pageSize }}'
AND filter.operatingSystem.displayNames = '{{ filter.operatingSystem.displayNames }}'
;
List all of the available reports.
SELECT
reports
FROM firebase.firebasecrashlytics.reports
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required
;