/bugsnag-errors | Type: Application | PCID required: Yes
Tools
bugsnag_errors_bulk_update_errors
Bulk Update Errors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_ids | string[] | Yes | — | Error Ids |
assigned_collaborator_id | string | No | — | The Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project. |
assigned_team_id | string | No | — | The Team to assign to the Error. Mutually exclusive with assigned_collaborator_id. |
issue_title | string | No | — | If the Error has a created_issue, the issue_title request field can be set to update the issue’s title. |
issue_url | string | No | — | Specifies the HTTP link to an external issue when adding or updating a link. |
notification_id | string | No | — | ID of the issue tracker to use for create_issue and link_issue operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if notification_id is set for link_issue operations if verify_issue_url is false. |
operation | string | Yes | — | The type of update operation to perform. The can be used to change the Error’s workflow state (e.g. marking the Error as fixed). It must be one of the following: * override_severity Set the Error’s severity to the newly supplied severity parameter. * assign Assign the Error to the Collaborator specified by the assigned_collaborator_id parameter. The error will be unassigned if assigned_collaborator_id is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error’s Project. * create_issue Create an issue for the Error. If the issue_title parameter is set, the new issue will be created with this title. * link_issue Link the Error to an existing issue. The url should be provided in the issue_url parameter. verify_issue_url can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if verify_issue_url is not supplied. * unlink_issue Remove the link between the Error and its current linked issue. * open Set the Error’s status to open. * snooze Snooze the error per the reopen_rules parameter. * fix Set the Error’s status to fixed. * ignore Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * delete Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status Open. * discard Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * undiscard Undiscard the Error. Future Events will be stored for this Error. This undoes the discard option. |
reopen_rules | object | No | — | Reopen Rules |
severity | string | No | — | - info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes |
verify_issue_url | boolean | No | — | Setting false will prevent Bugsnag from attempting to verify the issue_url with the configured issue tracker when linking an issue. Defaults to true if the parameter is not supplied. If no configured issue tracker the parameter is ignored. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Error Ids"
},
"assigned_collaborator_id": {
"type": "string",
"description": "The Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project."
},
"assigned_team_id": {
"type": "string",
"description": "The Team to assign to the Error. Mutually exclusive with `assigned_collaborator_id`."
},
"issue_title": {
"type": "string",
"description": "If the Error has a `created_issue`, the `issue_title` request field can be set to update the issue's title."
},
"issue_url": {
"type": "string",
"description": "Specifies the HTTP link to an external issue when adding or updating a link."
},
"notification_id": {
"type": "string",
"description": "ID of the issue tracker to use for `create_issue` and `link_issue` operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if `notification_id` is set for `link_issue` operations if `verify_issue_url` is `false`."
},
"operation": {
"type": "string",
"description": "The type of update operation to perform. The can be used to change the Error's workflow state (e.g. marking the Error as `fixed`). It must be one of the following: * `override_severity` Set the Error's severity to the newly supplied `severity` parameter. * `assign` Assign the Error to the Collaborator specified by the `assigned_collaborator_id` parameter. The error will be unassigned if `assigned_collaborator_id` is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error's Project. * `create_issue` Create an issue for the Error. If the `issue_title` parameter is set, the new issue will be created with this title. * `link_issue` Link the Error to an existing issue. The url should be provided in the `issue_url` parameter. `verify_issue_url` can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if `verify_issue_url` is not supplied. * `unlink_issue` Remove the link between the Error and its current linked issue. * `open` Set the Error's status to open. * `snooze` Snooze the error per the `reopen_rules` parameter. * `fix` Set the Error's status to fixed. * `ignore` Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * `delete` Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status `Open`. * `discard` Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * `undiscard` Undiscard the Error. Future Events will be stored for this Error. This undoes the `discard` option.",
"enum": [
"override_severity",
"assign",
"create_issue",
"link_issue",
"unlink_issue",
"open",
"snooze",
"fix",
"ignore",
"delete",
"discard",
"undiscard"
]
},
"reopen_rules": {
"type": "object",
"description": "Reopen Rules",
"properties": {
"reopen_if": {
"type": "string",
"description": "Must be one of the following: - `occurs_after` - Indicates that the error should be reopened if there are any occurrences after the specified time period. In this case, the `seconds` field must also be provided. - `n_occurrences_in_m_hours` - Indicates that the Error should be reopened after n occurrences over some period of hours. In this case, the `occurrences` and `hours` fields will both be present. - `n_additional_occurrences` - Indicates that the Error should be reopened after n more occurrences. In this case, the `additional_occurrences` field indicates the number of additional occurrences that were allowed before reopening. Cannot be set if more than 10,000 existing users are already affected by an error. - `n_additional_users` - Reopen the error after `n` more users are affected. In this case, the `additional_users` field must be provided.",
"enum": [
"occurs_after",
"n_occurrences_in_m_hours",
"n_additional_occurrences",
"n_additional_users"
]
},
"additional_users": {
"type": "number",
"description": "for `n_additional_users` reopen rules, the number of additional users to be affected by an Error before the Error is automatically reopened. Value cannot exceed 100,000."
},
"seconds": {
"type": "number",
"description": "for `occurs_after` reopen rules, the number of seconds that the Error should be snoozed for. Minimum 1 second."
},
"occurrences": {
"type": "number",
"description": "for `n_occurrences_in_m_hours` reopen rules, the number of occurrences to allow in the number of hours indicated by the `hours` field, before the Error is automatically reopened."
},
"hours": {
"type": "number",
"description": "for `n_occurrences_in_m_hours` reopen rules, the number of hours."
},
"additional_occurrences": {
"type": "number",
"description": "for `n_additional_occurrences` reopen rules, the number of additional occurrences allowed before reopening."
}
},
"required": [
"reopen_if"
]
},
"severity": {
"type": "string",
"description": "- info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes",
"enum": [
"info",
"warning",
"error"
]
},
"verify_issue_url": {
"type": "boolean",
"description": "Setting `false` will prevent Bugsnag from attempting to verify the `issue_url` with the configured issue tracker when linking an issue. Defaults to `true` if the parameter is not supplied. If no configured issue tracker the parameter is ignored."
}
},
"required": [
"PCID",
"project_id",
"error_ids",
"operation"
]
}
bugsnag_errors_configured_integration_test
Test a Configured Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
component | string | No | — | Comma separated list of components to create the issue in |
customFields | string | No | — | Additional JSON-encoded Jira fields |
host | string | No | — | URL of your Jira instance |
ignore_tls_validation | boolean | No | — | Whether to ignore TLS validation when making API calls |
issueType | string | No | — | The type of issue to be created |
password | string | No | — | API token generated for your Jira account (use your password for Jira Server) |
project_key | string | No | — | The project key for the Jira project |
user_name | string | No | — | Your Jira email |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"component": {
"type": "string",
"description": "Comma separated list of components to create the issue in"
},
"customFields": {
"type": "string",
"description": "Additional JSON-encoded Jira fields"
},
"host": {
"type": "string",
"description": "URL of your Jira instance"
},
"ignore_tls_validation": {
"type": "boolean",
"description": "Whether to ignore TLS validation when making API calls"
},
"issueType": {
"type": "string",
"description": "The type of issue to be created"
},
"password": {
"type": "string",
"description": "API token generated for your Jira account (use your password for Jira Server)"
},
"project_key": {
"type": "string",
"description": "The project key for the Jira project"
},
"user_name": {
"type": "string",
"description": "Your Jira email"
}
},
"required": [
"PCID",
"id"
]
}
bugsnag_errors_configured_integrations
Get a Configured Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
bugsnag_errors_configured_integrations_delete
Delete a Configured Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
bugsnag_errors_configured_integrations_update
Update a Configured Integration Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
id | string | Yes | — | The id value | |
configuration | object | Yes | — | The configuration value | |
disable_release_stages | string[] | No | — | The release stages that this notification should not be triggered for. Example: { “disable_release_stages”: [“development”, “staging”] } | |
disable_severities | string[] | No | — | The severities that this notification should not be triggered for. | |
disable_unhandled_states | string[] | No | — | The kinds of exceptions that this notification should not be triggered for. | |
integration_connection_id | string | No | — | The id of the integration connection to base this configured integration off of. | |
issue_automation | object | No | — | Issue Automation | |
label | string | null | No | — | A label for use in identifying the issue tracker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"configuration": {
"type": "object",
"description": "The configuration value",
"properties": {
"user_name": {
"type": "string",
"description": "User Name"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"password": {
"type": "string",
"description": "The password value"
}
}
},
"disable_release_stages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The release stages that this notification should not be triggered for. Example: { \"disable_release_stages\": [\"development\", \"staging\"] }"
},
"disable_severities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"error",
"warning",
"info"
]
},
"description": "The severities that this notification should not be triggered for."
},
"disable_unhandled_states": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unhandled",
"handled"
]
},
"description": "The kinds of exceptions that this notification should not be triggered for."
},
"integration_connection_id": {
"type": "string",
"description": "The id of the integration connection to base this configured integration off of."
},
"issue_automation": {
"type": "object",
"description": "Issue Automation",
"properties": {
"automation_style_type": {
"type": "string",
"description": "The identifier for the style type of the automation settings. For most integrations there is only one called 'default'."
},
"error_fixed": {
"type": "object",
"description": "Error Fixed"
},
"error_reopened": {
"type": "object",
"description": "Error Reopened"
},
"issue_resolved": {
"type": "object",
"description": "Issue Resolved"
},
"issue_unresolved": {
"type": "object",
"description": "Issue Unresolved"
}
}
},
"label": {
"type": [
"string",
"null"
],
"description": "A label for use in identifying the issue tracker."
}
},
"required": [
"PCID",
"id",
"configuration"
]
}
bugsnag_errors_create_comment_on_error
Create a Comment on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | ID of the Project |
error_id | string | Yes | — | ID of the Error |
message | string | Yes | — | The message value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "ID of the Project"
},
"error_id": {
"type": "string",
"description": "ID of the Error"
},
"message": {
"type": "string",
"description": "The message value"
}
},
"required": [
"PCID",
"project_id",
"error_id",
"message"
]
}
bugsnag_errors_delete_all_errors_in_project
Delete all Errors in a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_delete_comment
Delete a Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | string | Yes | — | ID of the comment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "string",
"description": "ID of the comment"
}
},
"required": [
"PCID",
"comment_id"
]
}
bugsnag_errors_delete_error_on_project
Delete an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_delete_event_by_id
Delete an Event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
event_id | string | Yes | — | Event Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"event_id": {
"type": "string",
"description": "Event Id"
}
},
"required": [
"PCID",
"project_id",
"event_id"
]
}
bugsnag_errors_get_bucketed_and_unbucketed_trends_on_error
List the Trends for an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | ID of the Project |
error_id | string | Yes | — | ID of the error |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | Search filters to restrict the events reported in the trend |
buckets_count | number | No | — | Number of buckets to group trend data into (max 50) |
resolution | string | No | — | The trend data will be grouped so that each bucket spans the given time period |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "ID of the Project"
},
"error_id": {
"type": "string",
"description": "ID of the error"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "Search filters to restrict the events reported in the trend",
"enum": [
"and",
"or"
]
},
"buckets_count": {
"type": "number",
"description": "Number of buckets to group trend data into (max 50)"
},
"resolution": {
"type": "string",
"description": "The trend data will be grouped so that each bucket spans the given time period",
"enum": [
"1m",
"5m",
"30m",
"2h",
"12h"
]
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_get_bucketed_and_unbucketed_trends_on_project
List the Trends for a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | ID of the project |
filters | object | No | — | Search filters to restrict the events reported in the trend |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
buckets_count | number | No | — | Number of buckets to group trend data into (max 50) |
resolution | string | No | — | The trend data will be grouped so that each bucket spans the given time period |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "ID of the project"
},
"filters": {
"type": "object",
"description": "Search filters to restrict the events reported in the trend",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"buckets_count": {
"type": "number",
"description": "Number of buckets to group trend data into (max 50)"
},
"resolution": {
"type": "string",
"description": "The trend data will be grouped so that each bucket spans the given time period",
"enum": [
"1m",
"5m",
"30m",
"2h",
"12h"
]
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_get_integrations
List the supported IntegrationsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bugsnag_errors_get_pivot_values_on_an_error
List values of a Pivot on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
event_field_display_id | string | Yes | — | Event Field Display Id |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
sort | string | No | — | Sort order for results |
base | string | No | — | The base value |
per_page | number | No | — | Number of results per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
},
"event_field_display_id": {
"type": "string",
"description": "Event Field Display Id"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"unsorted"
]
},
"base": {
"type": "string",
"description": "The base value"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"project_id",
"error_id",
"event_field_display_id"
]
}
bugsnag_errors_get_pivot_values_on_aproject
List values of a Pivot on a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
event_field_display_id | string | Yes | — | Event Field Display Id |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
sort | string | No | — | Sort order for results |
base | string | No | — | The base value |
per_page | number | No | — | Number of results per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"event_field_display_id": {
"type": "string",
"description": "Event Field Display Id"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"unsorted"
]
},
"base": {
"type": "string",
"description": "The base value"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"project_id",
"event_field_display_id"
]
}
bugsnag_errors_get_pivots_on_aproject
List Pivots on a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
summary_size | number | No | — | Summary Size |
pivots | string[] | No | — | The pivots value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"summary_size": {
"type": "number",
"description": "Summary Size"
},
"pivots": {
"type": "array",
"items": {
"type": "string"
},
"description": "The pivots value"
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_integrations_test
Test an Integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
configuration | object | Yes | — | The configuration value |
key | string | Yes | — | The key of the integration service to test. The supported keys can be obtained from /integrations |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"configuration": {
"type": "object",
"description": "The configuration value",
"properties": {
"user_name": {
"type": "string",
"description": "User Name"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"password": {
"type": "string",
"description": "The password value"
}
}
},
"key": {
"type": "string",
"description": "The key of the integration service to test. The supported keys can be obtained from [/integrations](https://developer.smartbear.com/bugsnag/docs/bugsnag-data-access-api#/Integrations/getIntegrations)"
}
},
"required": [
"PCID",
"configuration",
"key"
]
}
bugsnag_errors_list_comments_on_error
List Comments on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | ID of the Project |
error_id | string | Yes | — | ID of the Error |
sort | string | No | — | Comments are only sortable by creation time |
direction | string | No | — | Which direction to sort the results by |
per_page | number | No | — | How many results to return per page |
offset | number | No | — | The pagination offset. This will not typically need to be set manually, as the link header will contain the full url to the next page of results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "ID of the Project"
},
"error_id": {
"type": "string",
"description": "ID of the Error"
},
"sort": {
"type": "string",
"description": "Comments are only sortable by creation time"
},
"direction": {
"type": "string",
"description": "Which direction to sort the results by",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "number",
"description": "How many results to return per page"
},
"offset": {
"type": "number",
"description": "The pagination offset. This will not typically need to be set manually, as the `link` header will contain the full url to the next page of results."
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_list_events_on_error
List the Events on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
base | string | No | — | The base value |
sort | string | No | — | Sort order for results |
direction | string | No | — | The direction value |
per_page | number | No | — | Number of results per page |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
full_reports | boolean | No | — | Full Reports |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
},
"base": {
"type": "string",
"description": "The base value"
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"timestamp"
]
},
"direction": {
"type": "string",
"description": "The direction value",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"full_reports": {
"type": "boolean",
"description": "Full Reports"
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_list_events_on_project
List the Events on a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
base | string | No | — | The base value |
sort | string | No | — | Sort order for results |
direction | string | No | — | The direction value |
per_page | number | No | — | Number of results per page |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
full_reports | boolean | No | — | Full Reports |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"base": {
"type": "string",
"description": "The base value"
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"timestamp"
]
},
"direction": {
"type": "string",
"description": "The direction value",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"full_reports": {
"type": "boolean",
"description": "Full Reports"
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_list_organization_integration_connections
List the Integration Connections for an Organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | ID of the organization the integration connections belongs to. |
type | string | No | — | The external software to communicate with. Currently this can only be ‘jira’ or nil. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "ID of the organization the integration connections belongs to."
},
"type": {
"type": "string",
"description": "The external software to communicate with. Currently this can only be 'jira' or nil.",
"enum": [
"jira"
]
}
},
"required": [
"PCID",
"organization_id"
]
}
bugsnag_errors_list_pivots_on_an_error
List Pivots on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
summary_size | number | No | — | Summary Size |
pivots | string[] | No | — | The pivots value |
per_page | number | No | — | Number of results per page |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"summary_size": {
"type": "number",
"description": "Summary Size"
},
"pivots": {
"type": "array",
"items": {
"type": "string"
},
"description": "The pivots value"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_list_project_errors
List the Errors on a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
base | string | No | — | The base value |
sort | string | No | — | Sort order for results |
direction | string | No | — | The direction value |
per_page | integer | No | — | Number of results per page |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
histogram | string | No | — | The type of histogram to include in the response. Only specific values are accepted. When provided, adds trend data to each error in the response. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"base": {
"type": "string",
"description": "The base value"
},
"sort": {
"type": "string",
"description": "Sort order for results",
"enum": [
"last_seen",
"first_seen",
"users",
"events",
"unsorted"
]
},
"direction": {
"type": "string",
"description": "The direction value",
"enum": [
"asc",
"desc"
]
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
},
"histogram": {
"type": "string",
"description": "The type of histogram to include in the response. Only specific values are accepted. When provided, adds trend data to each error in the response.",
"enum": [
"two_week",
"dynamic"
]
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_project_configured_integration_summaries
List Summaries of the Configured Integrations for a Project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
per_page | number | No | — | Number of results per page |
page_token | number | No | — | Page Token |
category | string | No | — | The category value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"per_page": {
"type": "number",
"description": "Number of results per page"
},
"page_token": {
"type": "number",
"description": "Page Token"
},
"category": {
"type": "string",
"description": "The category value"
}
},
"required": [
"PCID",
"project_id"
]
}
bugsnag_errors_project_configured_integrations
Configure an Integration Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
project_id | string | Yes | — | Project Id | |
configuration | object | Yes | — | The configuration value | |
disable_release_stages | string[] | No | — | The release stages that this notification should not be triggered for. Example: { “disable_release_stages”: [“development”, “staging”] } | |
disable_severities | string[] | No | — | The severities that this notification should not be triggered for. | |
disable_unhandled_states | string[] | No | — | The kinds of exceptions that this notification should not be triggered for. | |
integration_connection_id | string | No | — | The id of the integration connection to base this configured integration off of. | |
integration_key | string | Yes | — | Key to identify the integration service. | |
issue_automation | object | No | — | Issue Automation | |
label | string | null | No | — | A label for use in identifying the issue tracker. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"configuration": {
"type": "object",
"description": "The configuration value",
"properties": {
"user_name": {
"type": "string",
"description": "User Name"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"password": {
"type": "string",
"description": "The password value"
}
}
},
"disable_release_stages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The release stages that this notification should not be triggered for. Example: { \"disable_release_stages\": [\"development\", \"staging\"] }"
},
"disable_severities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"error",
"warning",
"info"
]
},
"description": "The severities that this notification should not be triggered for."
},
"disable_unhandled_states": {
"type": "array",
"items": {
"type": "string",
"enum": [
"unhandled",
"handled"
]
},
"description": "The kinds of exceptions that this notification should not be triggered for."
},
"integration_connection_id": {
"type": "string",
"description": "The id of the integration connection to base this configured integration off of."
},
"integration_key": {
"type": "string",
"description": "Key to identify the integration service."
},
"issue_automation": {
"type": "object",
"description": "Issue Automation",
"properties": {
"automation_style_type": {
"type": "string",
"description": "The identifier for the style type of the automation settings. For most integrations there is only one called 'default'."
},
"error_fixed": {
"type": "object",
"description": "Error Fixed"
},
"error_reopened": {
"type": "object",
"description": "Error Reopened"
},
"issue_resolved": {
"type": "object",
"description": "Issue Resolved"
},
"issue_unresolved": {
"type": "object",
"description": "Issue Unresolved"
}
}
},
"label": {
"type": [
"string",
"null"
],
"description": "A label for use in identifying the issue tracker."
}
},
"required": [
"PCID",
"project_id",
"configuration",
"integration_key"
]
}
bugsnag_errors_update_comment
Update a Comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
comment_id | string | Yes | — | ID of the comment |
message | string | Yes | — | The updated content of the Comment |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment_id": {
"type": "string",
"description": "ID of the comment"
},
"message": {
"type": "string",
"description": "The updated content of the Comment"
}
},
"required": [
"PCID",
"comment_id",
"message"
]
}
bugsnag_errors_update_configured_integrations_trigger_config
Update a Configured Integration’s Trigger Config Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
trigger_config_key | string | Yes | — | Trigger Config Key |
active | boolean | Yes | — | The active value |
settings | object[] | No | — | settings for the trigger |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"trigger_config_key": {
"type": "string",
"description": "Trigger Config Key"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"saved_search_id": {
"type": "string",
"description": "must be from the same project as the notification, and have a `type` of `error`"
},
"basic_filter": {
"type": "object",
"description": "Basic Filter"
},
"include_all_states": {
"type": "boolean",
"description": "for `exception_config` and `project_spiking_config` are all states included, or just open"
},
"release_stages": {
"type": "array",
"items": {
"type": "string"
},
"description": "the release stages to include (only for `new_release_config` trigger config)"
},
"threshold": {
"type": "number",
"description": "for `error_event_frequency_config`, the threshold to alert above"
},
"condition": {
"type": "string",
"enum": [
"always",
"when_degraded"
],
"description": "for `weekly_performance_summary_email_config` and `daily_performance_summary_email_config`."
},
"period": {
"type": "string",
"description": "for 'error_event_frequency_config`, the period for which the threshold applies The supported string format is a whole number followed by either: - \"m\" which represents minutes - \"h\" which represents hours - \"d\" which represents days E.g. \"2h\" is a period of 2 hours. The minimum supported periods are: - \"1m\" - \"1h\" - \"1d\" The maximum supported period is 7 days, or: - \"10080m\" - \"168h\" - \"7d\""
}
}
},
"description": "settings for the trigger"
}
},
"required": [
"PCID",
"id",
"trigger_config_key",
"active"
]
}
bugsnag_errors_update_error_on_project
Update an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
assigned_collaborator_id | string | No | — | The Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project. |
assigned_team_id | string | No | — | The Team to assign to the Error. Mutually exclusive with assigned_collaborator_id. |
issue_title | string | No | — | If the Error has a created_issue, the issue_title request field can be set to update the issue’s title. |
issue_url | string | No | — | Specifies the HTTP link to an external issue when adding or updating a link. |
notification_id | string | No | — | ID of the issue tracker to use for create_issue and link_issue operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if notification_id is set for link_issue operations if verify_issue_url is false. |
operation | string | Yes | — | The type of update operation to perform. The can be used to change the Error’s workflow state (e.g. marking the Error as fixed). It must be one of the following: * override_severity Set the Error’s severity to the newly supplied severity parameter. * assign Assign the Error to the Collaborator specified by the assigned_collaborator_id parameter. The error will be unassigned if assigned_collaborator_id is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error’s Project. * create_issue Create an issue for the Error. If the issue_title parameter is set, the new issue will be created with this title. * link_issue Link the Error to an existing issue. The url should be provided in the issue_url parameter. verify_issue_url can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if verify_issue_url is not supplied. * unlink_issue Remove the link between the Error and its current linked issue. * open Set the Error’s status to open. * snooze Snooze the error per the reopen_rules parameter. * fix Set the Error’s status to fixed. * ignore Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * delete Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status Open. * discard Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * undiscard Undiscard the Error. Future Events will be stored for this Error. This undoes the discard option. |
reopen_rules | object | No | — | Reopen Rules |
severity | string | No | — | - info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes |
verify_issue_url | boolean | No | — | Setting false will prevent Bugsnag from attempting to verify the issue_url with the configured issue tracker when linking an issue. Defaults to true if the parameter is not supplied. If no configured issue tracker the parameter is ignored. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
},
"assigned_collaborator_id": {
"type": "string",
"description": "The Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project."
},
"assigned_team_id": {
"type": "string",
"description": "The Team to assign to the Error. Mutually exclusive with `assigned_collaborator_id`."
},
"issue_title": {
"type": "string",
"description": "If the Error has a `created_issue`, the `issue_title` request field can be set to update the issue's title."
},
"issue_url": {
"type": "string",
"description": "Specifies the HTTP link to an external issue when adding or updating a link."
},
"notification_id": {
"type": "string",
"description": "ID of the issue tracker to use for `create_issue` and `link_issue` operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if `notification_id` is set for `link_issue` operations if `verify_issue_url` is `false`."
},
"operation": {
"type": "string",
"description": "The type of update operation to perform. The can be used to change the Error's workflow state (e.g. marking the Error as `fixed`). It must be one of the following: * `override_severity` Set the Error's severity to the newly supplied `severity` parameter. * `assign` Assign the Error to the Collaborator specified by the `assigned_collaborator_id` parameter. The error will be unassigned if `assigned_collaborator_id` is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error's Project. * `create_issue` Create an issue for the Error. If the `issue_title` parameter is set, the new issue will be created with this title. * `link_issue` Link the Error to an existing issue. The url should be provided in the `issue_url` parameter. `verify_issue_url` can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if `verify_issue_url` is not supplied. * `unlink_issue` Remove the link between the Error and its current linked issue. * `open` Set the Error's status to open. * `snooze` Snooze the error per the `reopen_rules` parameter. * `fix` Set the Error's status to fixed. * `ignore` Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * `delete` Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status `Open`. * `discard` Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * `undiscard` Undiscard the Error. Future Events will be stored for this Error. This undoes the `discard` option.",
"enum": [
"override_severity",
"assign",
"create_issue",
"link_issue",
"unlink_issue",
"open",
"snooze",
"fix",
"ignore",
"delete",
"discard",
"undiscard"
]
},
"reopen_rules": {
"type": "object",
"description": "Reopen Rules",
"properties": {
"reopen_if": {
"type": "string",
"description": "Must be one of the following: - `occurs_after` - Indicates that the error should be reopened if there are any occurrences after the specified time period. In this case, the `seconds` field must also be provided. - `n_occurrences_in_m_hours` - Indicates that the Error should be reopened after n occurrences over some period of hours. In this case, the `occurrences` and `hours` fields will both be present. - `n_additional_occurrences` - Indicates that the Error should be reopened after n more occurrences. In this case, the `additional_occurrences` field indicates the number of additional occurrences that were allowed before reopening. Cannot be set if more than 10,000 existing users are already affected by an error. - `n_additional_users` - Reopen the error after `n` more users are affected. In this case, the `additional_users` field must be provided.",
"enum": [
"occurs_after",
"n_occurrences_in_m_hours",
"n_additional_occurrences",
"n_additional_users"
]
},
"additional_users": {
"type": "number",
"description": "for `n_additional_users` reopen rules, the number of additional users to be affected by an Error before the Error is automatically reopened. Value cannot exceed 100,000."
},
"seconds": {
"type": "number",
"description": "for `occurs_after` reopen rules, the number of seconds that the Error should be snoozed for. Minimum 1 second."
},
"occurrences": {
"type": "number",
"description": "for `n_occurrences_in_m_hours` reopen rules, the number of occurrences to allow in the number of hours indicated by the `hours` field, before the Error is automatically reopened."
},
"hours": {
"type": "number",
"description": "for `n_occurrences_in_m_hours` reopen rules, the number of hours."
},
"additional_occurrences": {
"type": "number",
"description": "for `n_additional_occurrences` reopen rules, the number of additional occurrences allowed before reopening."
}
},
"required": [
"reopen_if"
]
},
"severity": {
"type": "string",
"description": "- info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes",
"enum": [
"info",
"warning",
"error"
]
},
"verify_issue_url": {
"type": "boolean",
"description": "Setting `false` will prevent Bugsnag from attempting to verify the `issue_url` with the configured issue tracker when linking an issue. Defaults to `true` if the parameter is not supplied. If no configured issue tracker the parameter is ignored."
}
},
"required": [
"PCID",
"project_id",
"error_id",
"operation"
]
}
bugsnag_errors_view_error_on_project
View an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
error_id | string | Yes | — | Error Id |
filters | object | No | — | The filters value |
filter_groups | object | No | — | A map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details. |
filter_groups_join | string | No | — | The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"error_id": {
"type": "string",
"description": "Error Id"
},
"filters": {
"type": "object",
"description": "The filters value",
"properties": {
"user.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user ids. Matches Errors affecting any of these users. This refers to user ids in the context of your application. Exact match only."
},
"user.email": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of email addresses. Matches Errors that have affected users with email addresses matching any of the provided emails. Supports substring matches."
},
"user.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of user names. Matches Errors that have affected users with names matching any of the provided names. Supports substring matches."
},
"error.id": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error ids. Matches errors with IDs matching any of the given error IDs. Exact match only."
},
"error.status": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of error statuses. Matches Errors that have any of the given statuses. Exact match only."
},
"error.assigned_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of collaborator identifiers. Matches Errors that have been assigned to any of the given collaborators. Exact match only. Values can be `me` (for errors assigned to the current user), `anyone` (for errors assigned to anyone), a collaborator ID, or an email address."
},
"error.has_issue": {
"type": "boolean",
"description": "If set to true, matches Errors that have had an issue created for them. If set to false, matches Errors that have not had an issue created for them."
},
"app.release_stage": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of release stages. Matches Errors that have occurred in any of the given release stages. Exact match only."
},
"app.context": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application contexts. This refers to the action that was happening when the event occurred. Matches Errors that occurred in any of the given contexts. Supports substring matches."
},
"app.type": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application types. Matches Errors that occurred in any of the given application types. Exact match only."
},
"version.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred for the first time in any of the given versions. Supports the `?` and `*` wildcards."
},
"version.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of application versions. Matches Errors that occurred in any of the given versions. Supports the `?` and `*` wildcards."
},
"version_code.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred for the first time in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"version_code.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of version codes. Matches Errors that occurred in a version of the application identified by any of the given versions codes. The value of an Error's versionCode depends on the corresponding Project's type. In Android apps this will match the versionCode setting. In iOS apps, versionCode is taken from the Build Number setting. Exact match only."
},
"release.introduced_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred for the first time in any of the given Releases. Supports the `?` and `*` wildcards."
},
"release.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of Release `build_label`s, `app_version`s, `app_version_code`s, or `app_bundle_version`s. Matches Errors that occurred in any of the given Releases. Supports the `?` and `*` wildcards."
},
"feature_flag.seen_in": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have been seen with these feature flags (any variant), or the specific variant if specified. When type is `ne`, matches errors that have not been seen with these feature flags or variants. The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"feature_flag.exclusive_to": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of feature flag and variant names. When type is `eq`, matches errors that have only been seen with one of these feature flags (any variant), or one of the specific variants if specified. When type is `ne`, matches errors that have been seen with these feature flags or variants but are NOT exclusive to them (i.e., they have also been seen with other feature flags or variants). The feature flag name should be specified in the `value` field, and the variant name (optional) should be specified in the `child_value` field."
},
"event.class": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of classes. Matches Errors with any of the given classes. Supports substring matches."
},
"event.message": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of messages. Matches Errors with any of the given messages. Supports substring matches."
},
"event.file": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of file paths. Matches Errors with any of the given files in their stack traces'. Supports substring matches."
},
"event.method": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of method names. Matches Errors with any of the given methods in their stack traces'. Supports substring matches."
},
"event.severity": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of severities. Matches Errors with any of the given severities. Exact match only."
},
"event.since": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring after the given time. Exact match only."
},
"event.before": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a single timestamp. Matches Errors with events occurring before the given time. Exact match only."
},
"browser.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser names. Matches Errors with events originating from any of the given web browsers. Exact match only."
},
"browser.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing web browser versions. Matches Errors with events originating from any browser with the given version. Exact match only."
},
"os.name": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system names. Matches Errors with events originating from devices running any of the given operating systems. Exact match only."
},
"os.version": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing operating system versions. Matches Errors with events originating from devices running any of the given operating system versions. Supports the `?` and `*` wildcards."
},
"device.hostname": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing hostnames. Matches Errors with events occurring on any hosts with one of the given hostnames. Exact match only."
},
"device.manufacturer": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device manufacturer names. Matches Errors with events occurring on any devices made by the given manufacturers. Exact match only."
},
"device.model": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing device model names. Matches Errors with events occurring on any of the given device models. Exact match only."
},
"request.url": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of URLs. Matches Errors with events associated with requests to any of the given URLs. Supports substring matches."
},
"request.ip": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array of IP addresses. Matches Errors with events affecting any of the given IPs. Exact match only."
},
"device.jailbroken": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring on jailbroken devices."
},
"app.in_foreground": {
"type": "array",
"items": {
"type": "object"
},
"description": "An array containing a boolean. If `true`, matches Errors with events occurring when the application was in the foreground."
}
}
},
"filter_groups": {
"type": "object",
"description": "A map of filter groups, where each group is keyed with a unique identifier for the group e.g: ``` { \"0\": { ... }, \"1\": { ... } } ``` See the [Advanced Filters documentation](https://developer.smartbear.com/bugsnag/docs/data-access-filtering#advanced-filters) for more details."
},
"filter_groups_join": {
"type": "string",
"description": "The join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied",
"enum": [
"and",
"or"
]
}
},
"required": [
"PCID",
"project_id",
"error_id"
]
}
bugsnag_errors_view_event_by_id
View an Event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project Id |
event_id | string | Yes | — | Event Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project Id"
},
"event_id": {
"type": "string",
"description": "Event Id"
}
},
"required": [
"PCID",
"project_id",
"event_id"
]
}
bugsnag_errors_view_latest_event_on_error
View the latest Event on an Error Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
error_id | string | Yes | — | Error Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"error_id": {
"type": "string",
"description": "Error Id"
}
},
"required": [
"PCID",
"error_id"
]
}