Skip to main content
Server path: /bugsnag-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
bugsnag_projects_create_organization_projectCreate a Project in an Organization
bugsnag_projects_create_project_event_fieldCreate a custom Event Field
bugsnag_projects_create_user_starred_feature_flagStar a Feature Flag
bugsnag_projects_delete_projectDelete a Project
bugsnag_projects_delete_project_event_field_by_display_idDelete a custom Event Field
bugsnag_projects_delete_project_feature_flagDelete a Feature Flag
bugsnag_projects_delete_user_project_starred_feature_flagUnstar a Feature Flag
bugsnag_projects_get_organization_projectsList an Organization’s Projects
bugsnag_projects_get_projectView a Project
bugsnag_projects_get_project_feature_flagGet a Feature Flag
bugsnag_projects_get_project_feature_flag_error_overviewGet a Feature Flag’s Error Overview
bugsnag_projects_get_project_feature_flag_variantsList Variants on a Feature Flag by ID
bugsnag_projects_get_project_feature_flag_variants_by_nameList Variants on a Feature Flag by name
bugsnag_projects_get_project_feature_flag_variants_error_overviewGet a Feature Flag Variant’s Error Overview
bugsnag_projects_get_project_network_grouping_rulesetList a Project’s Network Grouping Ruleset
bugsnag_projects_get_project_page_load_span_group_by_idShow a Page Load Span Group by ID
bugsnag_projects_get_project_performance_score_overviewGet Performance Score Overview for Project
bugsnag_projects_get_project_release_by_idView a Release
bugsnag_projects_get_project_span_groupShow a Span Group
bugsnag_projects_get_project_span_group_distributionGet a Span Group’s distribution
bugsnag_projects_get_project_span_group_timelineGet a Span Group’s timeline
bugsnag_projects_get_project_stability_trendView the stability trend for a project
bugsnag_projects_get_release_groupRetrieve a Release Group
bugsnag_projects_get_spans_by_category_and_nameGet Spans for a Span Group
bugsnag_projects_list_project_event_fieldsList the Event Fields for a Project
bugsnag_projects_list_project_feature_flag_summariesList Feature Flag Summaries for a Project
bugsnag_projects_list_project_feature_flagsList Feature Flags on a Project
bugsnag_projects_list_project_page_load_span_groupsList Page Load Span Groups
bugsnag_projects_list_project_release_groupsList Release Groups on a Project
bugsnag_projects_list_project_releasesList Releases on a Project
bugsnag_projects_list_project_span_group_performance_targetsList Performance Targets for a Span Group by ID
bugsnag_projects_list_project_span_group_summariesList Span Group Summaries for a Project
bugsnag_projects_list_project_span_groupsList Span Groups on a Project
bugsnag_projects_list_project_starred_span_groupsList the starred Span Group descriptions
bugsnag_projects_list_project_trace_fieldsList the Trace Fields on a project
bugsnag_projects_list_release_group_releasesList Releases on a Release Group
bugsnag_projects_list_spans_by_span_group_idList Spans for a Span Group by ID
bugsnag_projects_list_spans_by_trace_idList Spans for a Trace
bugsnag_projects_replace_project_error_assignment_rulesReplace the ErrorAssignmentRules on a project
bugsnag_projects_update_projectUpdate a Project
bugsnag_projects_update_project_event_field_by_display_idUpdate a custom Event Field
bugsnag_projects_update_project_network_grouping_rulesetUpdate a Project’s Network Grouping Ruleset
bugsnag_projects_update_project_span_groupUpdate Span Group
bugsnag_projects_update_release_groupUpdate a Release Group

bugsnag_projects_create_organization_project

Create a Project in an Organization Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesID of the organization
ignore_old_browsersbooleanNoFor javascript projects this will filter errors from older browsers
namestringYesThe new Project’s name. Note that the first character should not start with a ’$’.
typestringYesused for Projects that use a framework other than those listed above

bugsnag_projects_create_project_event_field

Create a custom Event Field Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
filter_optionsobjectYesFilter Options
pathstringYesPath to locate the relevant data inside an Event data structure
pivot_optionsobjectNoPivot Options
reindexbooleanNoWhether to reindex historical events for this field

bugsnag_projects_create_user_starred_feature_flag

Star a Feature Flag Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project.
feature_flag_idstringYesID of the Feature Flag to star.

bugsnag_projects_delete_project

Delete a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project

bugsnag_projects_delete_project_event_field_by_display_id

Delete a custom Event Field Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
display_idstringYeshuman friendly ID for the EventField

bugsnag_projects_delete_project_feature_flag

Delete a Feature Flag Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project.
idstringYesID of the Feature Flag to unstar.

bugsnag_projects_delete_user_project_starred_feature_flag

Unstar a Feature Flag Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project.
idstringYesID of the Feature Flag to unstar.

bugsnag_projects_get_organization_projects

List an Organization’s Projects Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesthe ID of the organization
qstringNoSearch projects with names matching parameter
sortstringNoWhich field to sort the results by
directionstringNoWhich direction to sort the results by. Defaults to desc for all sorts except favorite. Defaults to asc if sorting by favorite (cannot sort favorites desc).
per_pagenumberNoHow many results to return per page

bugsnag_projects_get_project

View a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project

bugsnag_projects_get_project_feature_flag

Get a Feature Flag Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the FeatureFlag.
project_idstringYesID of the Project.
release_stage_namestringYesRelease stage name to get the feature flags for.
include_variant_summarybooleanNoWhether to include a summary of the Variants for the Feature Flag.

bugsnag_projects_get_project_feature_flag_error_overview

Get a Feature Flag’s Error Overview Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the FeatureFlag.
project_idstringYesID of the Project.
release_stage_namestringYesRelease stage name to get the feature flags for.

bugsnag_projects_get_project_feature_flag_variants

List Variants on a Feature Flag by ID Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the feature flag.
project_idstringYesID of the project.
release_stage_namestringNoRelease stage name to get the variants for.
qstringNoSearch for feature flags with a name matching this query parameter. Supports case-insensitive substring matching.
per_pagenumberNoHow many results to return per page.

bugsnag_projects_get_project_feature_flag_variants_by_name

List Variants on a Feature Flag by name Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName of the feature flag, case-sensitive and with no substring matching.
project_idstringYesID of the project.
release_stage_namestringNoRelease stage name to get the variants for.
qstringNoSearch for feature flag variants with a name matching this query parameter. Supports case-insensitive substring matching.
per_pagenumberNoHow many results to return per page.

bugsnag_projects_get_project_feature_flag_variants_error_overview

Get a Feature Flag Variant’s Error Overview Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the FeatureFlag.
project_idstringYesID of the Project.
variant_idsstring[]YesIDs for the FeatureFlag variants.
release_stage_namestringYesRelease stage name to get the feature flags for.

bugsnag_projects_get_project_network_grouping_ruleset

List a Project’s Network Grouping Ruleset Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to retrieve the endpoints for

bugsnag_projects_get_project_page_load_span_group_by_id

Show a Page Load Span Group by ID Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Page Load Span Group belongs.
idstringYesThe URL-encoded ID of the Page Load Span Group.
filtersobject[]NoThe current filters that are being applied.

bugsnag_projects_get_project_performance_score_overview

Get Performance Score Overview for Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project to retrieve the performance score for.
release_stage_namestringNoThe name of the release stage to filter the performance score.

bugsnag_projects_get_project_release_by_id

View a Release Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
release_idstringYesID of release to view

bugsnag_projects_get_project_span_group

Show a Span Group Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Group belongs.
idstringYesThe URL-encoded ID of the Span Group.
filtersobject[]NoThe current filters that are being applied.

bugsnag_projects_get_project_span_group_distribution

Get a Span Group’s distribution Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Group belongs.
idstringYesThe URL-encoded ID of the Span Group.
filtersobject[]NoThe current filters that are being applied.

bugsnag_projects_get_project_span_group_timeline

Get a Span Group’s timeline Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Group belongs.
idstringYesThe URL-encoded ID of the Span Group.
filtersobject[]NoThe current filters that are being applied.

bugsnag_projects_get_project_stability_trend

View the stability trend for a project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project to retrieve stability information for

bugsnag_projects_get_release_group

Retrieve a Release Group Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of release group to get

bugsnag_projects_get_spans_by_category_and_name

Get Spans for a Span Group Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the spans belong.
categorystringYesThe name of the Span Group Category.
namestringYesThe URL-encoded name of the Span Group.

bugsnag_projects_list_project_event_fields

List the Event Fields for a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project

bugsnag_projects_list_project_feature_flag_summaries

List Feature Flag Summaries for a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project.
qstringNoSearch for feature flags with a name matching this query parameter. Supports case-insensitive substring matching.
per_pagenumberNoHow many results to return per page.

bugsnag_projects_list_project_feature_flags

List Feature Flags on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project.
release_stage_namestringYesRelease stage name to get the feature flags for.
starred_at_topbooleanNoWhether to return starred Feature Flags at the top of the Feature Flags list.
include_variant_summarybooleanNoWhether to include a summary of the Variants for each Feature Flag.
qstringNoSearch for feature flags with a name matching this query parameter. Supports case-insensitive substring matching.
first_seenstringNoFilter to Feature Flags that were first seen in the release stage within the specified time frame.
include_inactivebooleanNoWhether to include inactive Feature Flags.
sortstringNoWhich field to sort on.
directionstringNoWhich direction to sort the results by.
per_pagenumberNoHow many results to return per page.

bugsnag_projects_list_project_page_load_span_groups

List Page Load Span Groups Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Page Load Span Groups belong.
sortstringNoThe field to sort the page load span groups by
directionstringNoThe direction to sort the page load span groups by
per_pagenumberNothe number of results per page
offsetnumberNothe offset for the next page of results
filtersobject[]NoThe current filters that are being applied.
starred_onlybooleanNoWhether to only return Page Load Span Groups the requesting user has starred.

bugsnag_projects_list_project_release_groups

List Release Groups on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project
release_stage_namestringYesname of release stage to list release groups for
top_onlybooleanNoreturn only the top release groups (default false)
visible_onlybooleanNoreturn only visible release groups (default false)
per_pagenumberNohow many results to return per page
page_tokenstringNovalue from the next relation in the Link response header to obtain the next page of results

bugsnag_projects_list_project_releases

List Releases on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
release_stagestringNorelease stage to filter by
basestringNodate and time (in ISO 8601 format) to search for releases before
sortstringNoHow to sort the results
offsetnumberNoThe pagination offset
per_pagenumberNoHow many results (between 1 and 10) to return per page

bugsnag_projects_list_project_span_group_performance_targets

List Performance Targets for a Span Group by ID Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the span group belongs.
idstringYesThe URL-encoded ID of the Span Group.

bugsnag_projects_list_project_span_group_summaries

List Span Group Summaries for a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Groups belong.
per_pageintegerNothe number of results per page
offsetintegerNothe offset for the next page of results
filtersobject[]NoThe current filters that are being applied.

bugsnag_projects_list_project_span_groups

List Span Groups on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Groups belong.
sortstringNoThe field to sort the span groups by
directionstringNoThe direction to sort the span groups by
per_pageintegerNothe number of results per page
offsetintegerNothe offset for the next page of results
filtersobject[]NoThe current filters that are being applied.
starred_onlybooleanNoWhether to only return Span Groups the requesting user has starred.

bugsnag_projects_list_project_starred_span_groups

List the starred Span Group descriptions Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the project to which the Span Groups belong.
categoriesstring[]NoThe performance categories of the Span Groups.
per_pageintegerNothe number of results per page
offsetintegerNothe offset for the next page of results

bugsnag_projects_list_project_trace_fields

List the Trace Fields on a project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Trace Field belongs.

bugsnag_projects_list_release_group_releases

List Releases on a Release Group Parameters:
ParameterTypeRequiredDefaultDescription
release_group_idstringYesID of release group to list releases for
per_pagenumberNohow many results to return per page
page_tokenstringNovalue from the next relation in the Link response header to obtain the next page of results

bugsnag_projects_list_spans_by_span_group_id

List Spans for a Span Group by ID Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the spans belong.
idstringYesThe URL-encoded ID of the Span Group.
filtersobject[]NoThe current filters that are being applied.
sortstringNoThe field to sort the results by.
directionstringNoThe direction to sort the results by.
per_pageintegerNoThe number of results to return per page. Defaults to 20.

bugsnag_projects_list_spans_by_trace_id

List Spans for a Trace Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the spans belong.
trace_idstringYesThe ID of the Trace to which the spans belong.
fromstringYesBeginning of window to return spans from.
tostringYesEnd of window to return spans from.
target_span_idstringNoThe ID of a Span within the Trace to focus on. If provided the target Span and its direct children will be returned ahead of other Spans in the Trace.
per_pageintegerNoThe number of results to return per page. Defaults to 20.

bugsnag_projects_replace_project_error_assignment_rules

Replace the ErrorAssignmentRules on a project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the ErrorAssignmentRule belongs.
assignment_rulesobject[]NoAssignment Rules

bugsnag_projects_update_project

Update a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project
collaborator_idsstring[]NoIf provided in the request, the Project will be updated so that its set of Collaborators will reflect those indicated by this list of ids. Existing Collaborators whose ids do not appear in the list will be removed from the Project.
discarded_app_versionsany[]NoA list of app versions whose events will be discarded if received for the Project. Supports regular expressions and semver ranges. Errors matching these versions won’t be processed by Bugsnag, and you won’t receive notifications about them.
discarded_errorsany[]NoA list of Error classes whose events will be discarded if received for the Project. Errors with these classes won’t be processed by Bugsnag, and you won’t receive notifications about them.
global_groupingany[]NoA list of error classes. Events with these classes will be grouped by their class, regardless of the location that they occur in the Project’s source code. Altering a Project’s global_grouping will not cause existing errors to be regrouped. Note: In the UI this is referred to as grouping by error class. Example: ["foo", "bar"]
ignore_old_browsersbooleanNoWhether the Events in the Project will be ignored if they originate from old web browsers. Relevant to JavaScript Projects only.
ignored_browser_versionsobjectNoRelevant to JavaScript Projects only. A mapping a of browser name to browser version. If set, Events in the Project will be ignored if they originate from a browser specified here whose version is earlier than the given version. Keys must be one of the following strings: chrome, ie, firefox, safari, android, uc, opera, opera_mini, samsung, blackberry, sogou, other. Values must be a number indicating which which version to ignore up to (but not including), or one of the strings: ignore_all, ignore_none Example: { "chrome": "ignore_none", "safari": 6, "other": "ignore_all" }
location_groupingany[]NoA list of error classes. Events with these classes will be grouped by their context. Altering a Project’s location_grouping will not cause existing errors to be regrouped. Note: In the UI this is referred to as grouping by error context.
namestringNoThe name value
resolve_on_deploybooleanNoIf true, every error in the Project will be marked as ‘fixed’ after using the Deploy Tracking API to notify Bugsnag of a new production deploy. Applies to non-JavaScript Projects only.
url_whitelistany[]NoWhen configured, the script source of each error’s innermost stack trace’s top frame is checked. If the script was not served from a matching domain the error will not be processed by BugSnag and will be discarded. Provide a list of newline separated domain names. To match example.com and its subdomains specify *.example.com. Relevant to JavaScript Projects only.

bugsnag_projects_update_project_event_field_by_display_id

Update a custom Event Field Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
display_idstringYeshuman friendly ID for the EventField
filter_optionsobjectYesFilter Options
pathstringYesPath to locate the relevant data inside an Event data structure
pivot_optionsobjectNoPivot Options
reindexbooleanNoWhether to reindex historical events for this field

bugsnag_projects_update_project_network_grouping_ruleset

Update a Project’s Network Grouping Ruleset Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to retrieve the endpoints for
endpointsstring[]YesThe URL patterns by which network spans are grouped.

bugsnag_projects_update_project_span_group

Update Span Group Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesThe ID of the Project to which the Span Group belongs.
idstringYesThe URL-encoded ID of the Span Group.
is_starredbooleanNowhether or not the Span Group is starred by the user.

bugsnag_projects_update_release_group

Update a Release Group Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of release group to update
visiblebooleanYesthe updated visibility