> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # bugsnag-projects > Bugsnag Projects - projects, releases, spans, and feature flags **Server path:** `/bugsnag-projects` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | [`bugsnag_projects_create_organization_project`](#bugsnag_projects_create_organization_project) | Create a Project in an Organization | | [`bugsnag_projects_create_project_event_field`](#bugsnag_projects_create_project_event_field) | Create a custom Event Field | | [`bugsnag_projects_create_user_starred_feature_flag`](#bugsnag_projects_create_user_starred_feature_flag) | Star a Feature Flag | | [`bugsnag_projects_delete_project`](#bugsnag_projects_delete_project) | Delete a Project | | [`bugsnag_projects_delete_project_event_field_by_display_id`](#bugsnag_projects_delete_project_event_field_by_display_id) | Delete a custom Event Field | | [`bugsnag_projects_delete_project_feature_flag`](#bugsnag_projects_delete_project_feature_flag) | Delete a Feature Flag | | [`bugsnag_projects_delete_user_project_starred_feature_flag`](#bugsnag_projects_delete_user_project_starred_feature_flag) | Unstar a Feature Flag | | [`bugsnag_projects_get_organization_projects`](#bugsnag_projects_get_organization_projects) | List an Organization's Projects | | [`bugsnag_projects_get_project`](#bugsnag_projects_get_project) | View a Project | | [`bugsnag_projects_get_project_feature_flag`](#bugsnag_projects_get_project_feature_flag) | Get a Feature Flag | | [`bugsnag_projects_get_project_feature_flag_error_overview`](#bugsnag_projects_get_project_feature_flag_error_overview) | Get a Feature Flag's Error Overview | | [`bugsnag_projects_get_project_feature_flag_variants`](#bugsnag_projects_get_project_feature_flag_variants) | List Variants on a Feature Flag by ID | | [`bugsnag_projects_get_project_feature_flag_variants_by_name`](#bugsnag_projects_get_project_feature_flag_variants_by_name) | List Variants on a Feature Flag by name | | [`bugsnag_projects_get_project_feature_flag_variants_error_overview`](#bugsnag_projects_get_project_feature_flag_variants_error_overview) | Get a Feature Flag Variant's Error Overview | | [`bugsnag_projects_get_project_network_grouping_ruleset`](#bugsnag_projects_get_project_network_grouping_ruleset) | List a Project's Network Grouping Ruleset | | [`bugsnag_projects_get_project_page_load_span_group_by_id`](#bugsnag_projects_get_project_page_load_span_group_by_id) | Show a Page Load Span Group by ID | | [`bugsnag_projects_get_project_performance_score_overview`](#bugsnag_projects_get_project_performance_score_overview) | Get Performance Score Overview for Project | | [`bugsnag_projects_get_project_release_by_id`](#bugsnag_projects_get_project_release_by_id) | View a Release | | [`bugsnag_projects_get_project_span_group`](#bugsnag_projects_get_project_span_group) | Show a Span Group | | [`bugsnag_projects_get_project_span_group_distribution`](#bugsnag_projects_get_project_span_group_distribution) | Get a Span Group's distribution | | [`bugsnag_projects_get_project_span_group_timeline`](#bugsnag_projects_get_project_span_group_timeline) | Get a Span Group's timeline | | [`bugsnag_projects_get_project_stability_trend`](#bugsnag_projects_get_project_stability_trend) | View the stability trend for a project | | [`bugsnag_projects_get_release_group`](#bugsnag_projects_get_release_group) | Retrieve a Release Group | | [`bugsnag_projects_get_spans_by_category_and_name`](#bugsnag_projects_get_spans_by_category_and_name) | Get Spans for a Span Group | | [`bugsnag_projects_list_project_event_fields`](#bugsnag_projects_list_project_event_fields) | List the Event Fields for a Project | | [`bugsnag_projects_list_project_feature_flag_summaries`](#bugsnag_projects_list_project_feature_flag_summaries) | List Feature Flag Summaries for a Project | | [`bugsnag_projects_list_project_feature_flags`](#bugsnag_projects_list_project_feature_flags) | List Feature Flags on a Project | | [`bugsnag_projects_list_project_page_load_span_groups`](#bugsnag_projects_list_project_page_load_span_groups) | List Page Load Span Groups | | [`bugsnag_projects_list_project_release_groups`](#bugsnag_projects_list_project_release_groups) | List Release Groups on a Project | | [`bugsnag_projects_list_project_releases`](#bugsnag_projects_list_project_releases) | List Releases on a Project | | [`bugsnag_projects_list_project_span_group_performance_targets`](#bugsnag_projects_list_project_span_group_performance_targets) | List Performance Targets for a Span Group by ID | | [`bugsnag_projects_list_project_span_group_summaries`](#bugsnag_projects_list_project_span_group_summaries) | List Span Group Summaries for a Project | | [`bugsnag_projects_list_project_span_groups`](#bugsnag_projects_list_project_span_groups) | List Span Groups on a Project | | [`bugsnag_projects_list_project_starred_span_groups`](#bugsnag_projects_list_project_starred_span_groups) | List the starred Span Group descriptions | | [`bugsnag_projects_list_project_trace_fields`](#bugsnag_projects_list_project_trace_fields) | List the Trace Fields on a project | | [`bugsnag_projects_list_release_group_releases`](#bugsnag_projects_list_release_group_releases) | List Releases on a Release Group | | [`bugsnag_projects_list_spans_by_span_group_id`](#bugsnag_projects_list_spans_by_span_group_id) | List Spans for a Span Group by ID | | [`bugsnag_projects_list_spans_by_trace_id`](#bugsnag_projects_list_spans_by_trace_id) | List Spans for a Trace | | [`bugsnag_projects_replace_project_error_assignment_rules`](#bugsnag_projects_replace_project_error_assignment_rules) | Replace the ErrorAssignmentRules on a project | | [`bugsnag_projects_update_project`](#bugsnag_projects_update_project) | Update a Project | | [`bugsnag_projects_update_project_event_field_by_display_id`](#bugsnag_projects_update_project_event_field_by_display_id) | Update a custom Event Field | | [`bugsnag_projects_update_project_network_grouping_ruleset`](#bugsnag_projects_update_project_network_grouping_ruleset) | Update a Project's Network Grouping Ruleset | | [`bugsnag_projects_update_project_span_group`](#bugsnag_projects_update_project_span_group) | Update Span Group | | [`bugsnag_projects_update_release_group`](#bugsnag_projects_update_release_group) | Update a Release Group | *** ## bugsnag\_projects\_create\_organization\_project Create a Project in an Organization **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------- | | `organization_id` | string | Yes | — | ID of the organization | | `ignore_old_browsers` | boolean | No | — | For javascript projects this will filter errors from older browsers | | `name` | string | Yes | — | The new Project's name. Note that the first character should not start with a '\$'. | | `type` | string | Yes | — | used for Projects that use a framework other than those listed above | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id": { "type": "string", "description": "ID of the organization" }, "ignore_old_browsers": { "type": "boolean", "description": "For javascript projects this will filter errors from older browsers" }, "name": { "type": "string", "description": "The new Project's name. Note that the first character should not start with a '$'." }, "type": { "type": "string", "description": "used for Projects that use a framework other than those listed above", "enum": [ "android", "angular", "asgi", "aspnet", "aspnet_core", "backbone", "bottle", "cocos2dx", "connect", "django", "dotnet", "dotnet_desktop", "dotnet_mvc", "electron", "ember", "eventmachine", "expo", "express", "flask", "flutter", "gin", "go", "go_net_http", "heroku", "ios", "java", "java_desktop", "js", "vega", "koa", "laravel", "lumen", "magento", "martini", "minidump", "ndk", "negroni", "nintendo_switch", "node", "osx", "other_desktop", "other_mobile", "other_tv", "php", "python", "rack", "rails", "react", "reactnative", "restify", "revel", "ruby", "silex", "sinatra", "spring", "symfony", "tornado", "tvos", "unity", "unrealengine", "vue", "watchos", "webapi", "wordpress", "wpf", "wsgi", "other" ] } }, "required": [ "PCID", "organization_id", "name", "type" ] } ``` *** ## bugsnag\_projects\_create\_project\_event\_field Create a custom Event Field **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the Project | | `filter_options` | object | Yes | — | Filter Options | | `path` | string | Yes | — | [Path](https://docs.bugsnag.com/product/custom-filters/advanced-custom-filters/#custom-filter-path) to locate the relevant data inside an Event data structure | | `pivot_options` | object | No | — | Pivot Options | | `reindex` | boolean | No | — | Whether to reindex historical events for this field | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" }, "filter_options": { "type": "object", "description": "Filter Options", "properties": { "name": { "type": "string", "description": "Human readable name for the filter" } } }, "path": { "type": "string", "description": "[Path](https://docs.bugsnag.com/product/custom-filters/advanced-custom-filters/#custom-filter-path) to locate the relevant data inside an Event data structure" }, "pivot_options": { "type": "object", "description": "Pivot Options", "properties": { "name": { "type": "string", "description": "Human readable display name of the pivot." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Additional fields that are displayed in the pivot tab, for example the users pivot displays user name and email in addition to ID." }, "summary": { "type": "boolean", "description": "Whether this field is displayed in the error summary section of the dashboard" }, "values": { "type": "boolean", "description": "Whether this field is displayed as a pivot tab in the dashboard" }, "cardinality": { "type": "boolean", "description": "Whether the unique values of this field are calculated" }, "average": { "type": "boolean", "description": "Whether an average value of this field is calculated" } } }, "reindex": { "type": "boolean", "description": "Whether to reindex historical events for this field" } }, "required": [ "PCID", "project_id", "filter_options", "path" ] } ``` *** ## bugsnag\_projects\_create\_user\_starred\_feature\_flag Star a Feature Flag **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------- | | `project_id` | string | Yes | — | ID of the Project. | | `feature_flag_id` | string | Yes | — | ID of the Feature Flag to star. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project." }, "feature_flag_id": { "type": "string", "description": "ID of the Feature Flag to star." } }, "required": [ "PCID", "project_id", "feature_flag_id" ] } ``` *** ## bugsnag\_projects\_delete\_project Delete a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------- | | `project_id` | string | Yes | — | ID of the project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the project" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_delete\_project\_event\_field\_by\_display\_id Delete a custom Event Field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------ | | `project_id` | string | Yes | — | ID of the Project | | `display_id` | string | Yes | — | human friendly ID for the EventField | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" }, "display_id": { "type": "string", "description": "human friendly ID for the EventField" } }, "required": [ "PCID", "project_id", "display_id" ] } ``` *** ## bugsnag\_projects\_delete\_project\_feature\_flag Delete a Feature Flag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------- | | `project_id` | string | Yes | — | ID of the Project. | | `id` | string | Yes | — | ID of the Feature Flag to unstar. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project." }, "id": { "type": "string", "description": "ID of the Feature Flag to unstar." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_delete\_user\_project\_starred\_feature\_flag Unstar a Feature Flag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------- | | `project_id` | string | Yes | — | ID of the Project. | | `id` | string | Yes | — | ID of the Feature Flag to unstar. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project." }, "id": { "type": "string", "description": "ID of the Feature Flag to unstar." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_get\_organization\_projects List an Organization's Projects **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `organization_id` | string | Yes | — | the ID of the organization | | `q` | string | No | — | Search projects with names matching parameter | | `sort` | string | No | — | Which field to sort the results by | | `direction` | string | No | — | Which direction to sort the results by. Defaults to `desc` for all sorts except `favorite`. Defaults to `asc` if sorting by `favorite` (cannot sort `favorite`s `desc`). | | `per_page` | number | No | — | How many results to return per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id": { "type": "string", "description": "the ID of the organization" }, "q": { "type": "string", "description": "Search projects with names matching parameter" }, "sort": { "type": "string", "description": "Which field to sort the results by", "enum": [ "created_at", "name", "favorite" ] }, "direction": { "type": "string", "description": "Which direction to sort the results by. Defaults to `desc` for all sorts except `favorite`. Defaults to `asc` if sorting by `favorite` (cannot sort `favorite`s `desc`).", "enum": [ "asc", "desc" ] }, "per_page": { "type": "number", "description": "How many results to return per page" } }, "required": [ "PCID", "organization_id" ] } ``` *** ## bugsnag\_projects\_get\_project View a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------- | | `project_id` | string | Yes | — | ID of the project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the project" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_feature\_flag Get a Feature Flag **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------ | | `id` | string | Yes | — | ID of the FeatureFlag. | | `project_id` | string | Yes | — | ID of the Project. | | `release_stage_name` | string | Yes | — | Release stage name to get the feature flags for. | | `include_variant_summary` | boolean | No | — | Whether to include a summary of the Variants for the Feature Flag. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the FeatureFlag." }, "project_id": { "type": "string", "description": "ID of the Project." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the feature flags for." }, "include_variant_summary": { "type": "boolean", "description": "Whether to include a summary of the Variants for the Feature Flag." } }, "required": [ "PCID", "id", "project_id", "release_stage_name" ] } ``` *** ## bugsnag\_projects\_get\_project\_feature\_flag\_error\_overview Get a Feature Flag's Error Overview **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------ | | `id` | string | Yes | — | ID of the FeatureFlag. | | `project_id` | string | Yes | — | ID of the Project. | | `release_stage_name` | string | Yes | — | Release stage name to get the feature flags for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the FeatureFlag." }, "project_id": { "type": "string", "description": "ID of the Project." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the feature flags for." } }, "required": [ "PCID", "id", "project_id", "release_stage_name" ] } ``` *** ## bugsnag\_projects\_get\_project\_feature\_flag\_variants List Variants on a Feature Flag by ID **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | ID of the feature flag. | | `project_id` | string | Yes | — | ID of the project. | | `release_stage_name` | string | No | — | Release stage name to get the variants for. | | `q` | string | No | — | Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching. | | `per_page` | number | No | — | How many results to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the feature flag." }, "project_id": { "type": "string", "description": "ID of the project." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the variants for." }, "q": { "type": "string", "description": "Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching." }, "per_page": { "type": "number", "description": "How many results to return per page." } }, "required": [ "PCID", "id", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_feature\_flag\_variants\_by\_name List Variants on a Feature Flag by name **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | Name of the feature flag, case-sensitive and with no substring matching. | | `project_id` | string | Yes | — | ID of the project. | | `release_stage_name` | string | No | — | Release stage name to get the variants for. | | `q` | string | No | — | Search for feature flag variants with a name matching this query parameter. Supports case-insensitive substring matching. | | `per_page` | number | No | — | How many results to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "Name of the feature flag, case-sensitive and with no substring matching." }, "project_id": { "type": "string", "description": "ID of the project." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the variants for." }, "q": { "type": "string", "description": "Search for feature flag variants with a name matching this query parameter. Supports case-insensitive substring matching." }, "per_page": { "type": "number", "description": "How many results to return per page." } }, "required": [ "PCID", "name", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_feature\_flag\_variants\_error\_overview Get a Feature Flag Variant's Error Overview **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------ | | `id` | string | Yes | — | ID of the FeatureFlag. | | `project_id` | string | Yes | — | ID of the Project. | | `variant_ids` | string\[] | Yes | — | IDs for the FeatureFlag variants. | | `release_stage_name` | string | Yes | — | Release stage name to get the feature flags for. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the FeatureFlag." }, "project_id": { "type": "string", "description": "ID of the Project." }, "variant_ids": { "type": "array", "items": { "type": "string" }, "description": "IDs for the FeatureFlag variants." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the feature flags for." } }, "required": [ "PCID", "id", "project_id", "variant_ids", "release_stage_name" ] } ``` *** ## bugsnag\_projects\_get\_project\_network\_grouping\_ruleset List a Project's Network Grouping Ruleset **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to retrieve the endpoints for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to retrieve the endpoints for" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_page\_load\_span\_group\_by\_id Show a Page Load Span Group by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Page Load Span Group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Page Load Span Group. | | `filters` | object\[] | No | — | The current filters that are being applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Page Load Span Group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Page Load Span Group." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_get\_project\_performance\_score\_overview Get Performance Score Overview for Project **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | -------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the project to retrieve the performance score for. | | `release_stage_name` | string | No | — | The name of the release stage to filter the performance score. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the project to retrieve the performance score for." }, "release_stage_name": { "type": "string", "description": "The name of the release stage to filter the performance score." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_release\_by\_id View a Release **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------- | | `project_id` | string | Yes | — | ID of the Project | | `release_id` | string | Yes | — | ID of release to view | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" }, "release_id": { "type": "string", "description": "ID of release to view" } }, "required": [ "PCID", "project_id", "release_id" ] } ``` *** ## bugsnag\_projects\_get\_project\_span\_group Show a Span Group **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Span Group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | | `filters` | object\[] | No | — | The current filters that are being applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_get\_project\_span\_group\_distribution Get a Span Group's distribution **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Span Group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | | `filters` | object\[] | No | — | The current filters that are being applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_get\_project\_span\_group\_timeline Get a Span Group's timeline **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Span Group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | | `filters` | object\[] | No | — | The current filters that are being applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_get\_project\_stability\_trend View the stability trend for a project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the project to retrieve stability information for | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the project to retrieve stability information for" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_get\_release\_group Retrieve a Release Group **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------- | | `id` | string | Yes | — | ID of release group to get | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of release group to get" } }, "required": [ "PCID", "id" ] } ``` *** ## bugsnag\_projects\_get\_spans\_by\_category\_and\_name Get Spans for a Span Group **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the spans belong. | | `category` | string | Yes | — | The name of the Span Group Category. | | `name` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) name of the Span Group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the spans belong." }, "category": { "type": "string", "description": "The name of the Span Group Category." }, "name": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) name of the Span Group." } }, "required": [ "PCID", "project_id", "category", "name" ] } ``` *** ## bugsnag\_projects\_list\_project\_event\_fields List the Event Fields for a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------- | | `project_id` | string | Yes | — | ID of the Project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_feature\_flag\_summaries List Feature Flag Summaries for a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the Project. | | `q` | string | No | — | Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching. | | `per_page` | number | No | — | How many results to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project." }, "q": { "type": "string", "description": "Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching." }, "per_page": { "type": "number", "description": "How many results to return per page." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_feature\_flags List Feature Flags on a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the Project. | | `release_stage_name` | string | Yes | — | Release stage name to get the feature flags for. | | `starred_at_top` | boolean | No | — | Whether to return starred Feature Flags at the top of the Feature Flags list. | | `include_variant_summary` | boolean | No | — | Whether to include a summary of the Variants for each Feature Flag. | | `q` | string | No | — | Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching. | | `first_seen` | string | No | — | Filter to Feature Flags that were first seen in the release stage within the specified time frame. | | `include_inactive` | boolean | No | — | Whether to include inactive Feature Flags. | | `sort` | string | No | — | Which field to sort on. | | `direction` | string | No | — | Which direction to sort the results by. | | `per_page` | number | No | — | How many results to return per page. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project." }, "release_stage_name": { "type": "string", "description": "Release stage name to get the feature flags for." }, "starred_at_top": { "type": "boolean", "description": "Whether to return starred Feature Flags at the top of the Feature Flags list." }, "include_variant_summary": { "type": "boolean", "description": "Whether to include a summary of the Variants for each Feature Flag." }, "q": { "type": "string", "description": "Search for feature flags with a name matching this query parameter. Supports case-insensitive substring matching." }, "first_seen": { "type": "string", "description": "Filter to Feature Flags that were first seen in the release stage within the specified time frame.", "enum": [ "all", "this_week", "today" ] }, "include_inactive": { "type": "boolean", "description": "Whether to include inactive Feature Flags." }, "sort": { "type": "string", "description": "Which field to sort on.", "enum": [ "name", "first_seen" ] }, "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." } }, "required": [ "PCID", "project_id", "release_stage_name" ] } ``` *** ## bugsnag\_projects\_list\_project\_page\_load\_span\_groups List Page Load Span Groups **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Page Load Span Groups belong. | | `sort` | string | No | — | The field to sort the page load span groups by | | `direction` | string | No | — | The direction to sort the page load span groups by | | `per_page` | number | No | — | the number of results per page | | `offset` | number | No | — | the offset for the next page of results | | `filters` | object\[] | No | — | The current filters that are being applied. | | `starred_only` | boolean | No | — | Whether to only return Page Load Span Groups the requesting user has starred. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Page Load Span Groups belong." }, "sort": { "type": "string", "description": "The field to sort the page load span groups by", "enum": [ "name", "total_spans", "full_page_load_total_spans", "route_change_load_total_spans", "cls", "ttfb", "fcp", "route_change_total_spans", "lcp", "fid", "full_page_load_duration_p50", "full_page_load_duration_p75", "full_page_load_duration_p90", "full_page_load_duration_p95", "full_page_load_duration_p99", "route_change_duration_p50", "route_change_duration_p75", "route_change_duration_p90", "route_change_duration_p95", "route_change_duration_p99" ] }, "direction": { "type": "string", "description": "The direction to sort the page load span groups by", "enum": [ "desc", "asc" ] }, "per_page": { "type": "number", "description": "the number of results per page" }, "offset": { "type": "number", "description": "the offset for the next page of results" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." }, "starred_only": { "type": "boolean", "description": "Whether to only return Page Load Span Groups the requesting user has starred." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_release\_groups List Release Groups on a Project **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the project | | `release_stage_name` | string | Yes | — | name of release stage to list release groups for | | `top_only` | boolean | No | — | return only the top release groups (default false) | | `visible_only` | boolean | No | — | return only visible release groups (default false) | | `per_page` | number | No | — | how many results to return per page | | `page_token` | string | No | — | value from the next relation in the Link response header to obtain the next page of results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the project" }, "release_stage_name": { "type": "string", "description": "name of release stage to list release groups for" }, "top_only": { "type": "boolean", "description": "return only the top release groups (default false)" }, "visible_only": { "type": "boolean", "description": "return only visible release groups (default false)" }, "per_page": { "type": "number", "description": "how many results to return per page" }, "page_token": { "type": "string", "description": "value from the next relation in the Link response header to obtain the next page of results" } }, "required": [ "PCID", "project_id", "release_stage_name" ] } ``` *** ## bugsnag\_projects\_list\_project\_releases List Releases on a Project **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the Project | | `release_stage` | string | No | — | release stage to filter by | | `base` | string | No | — | date and time (in ISO 8601 format) to search for releases before | | `sort` | string | No | — | How to sort the results | | `offset` | number | No | — | The pagination offset | | `per_page` | number | No | — | How many results (between 1 and 10) to return per page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" }, "release_stage": { "type": "string", "description": "release stage to filter by" }, "base": { "type": "string", "description": "date and time (in ISO 8601 format) to search for releases before" }, "sort": { "type": "string", "description": "How to sort the results", "enum": [ "timestamp", "percent_of_sessions" ] }, "offset": { "type": "number", "description": "The pagination offset" }, "per_page": { "type": "number", "description": "How many results (between 1 and 10) to return per page" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_span\_group\_performance\_targets List Performance Targets for a Span Group by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the span group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the span group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_list\_project\_span\_group\_summaries List Span Group Summaries for a Project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ------------------------------------------------------ | | `project_id` | string | Yes | — | The ID of the Project to which the Span Groups belong. | | `per_page` | integer | No | — | the number of results per page | | `offset` | integer | No | — | the offset for the next page of results | | `filters` | object\[] | No | — | The current filters that are being applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Groups belong." }, "per_page": { "type": "integer", "description": "the number of results per page" }, "offset": { "type": "integer", "description": "the offset for the next page of results" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_span\_groups List Span Groups on a Project **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | --------- | -------- | ------- | ------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Span Groups belong. | | `sort` | string | No | — | The field to sort the span groups by | | `direction` | string | No | — | The direction to sort the span groups by | | `per_page` | integer | No | — | the number of results per page | | `offset` | integer | No | — | the offset for the next page of results | | `filters` | object\[] | No | — | The current filters that are being applied. | | `starred_only` | boolean | No | — | Whether to only return Span Groups the requesting user has starred. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Groups belong." }, "sort": { "type": "string", "description": "The field to sort the span groups by", "enum": [ "total_spans", "last_seen", "name", "display_name", "network_http_method", "rendering_slow_frame_span_percentage", "rendering_frozen_frame_span_percentage", "duration_p50", "duration_p75", "duration_p90", "duration_p95", "duration_p99", "system_metrics_cpu_total_mean_p50", "system_metrics_cpu_total_mean_p75", "system_metrics_cpu_total_mean_p90", "system_metrics_cpu_total_mean_p95", "system_metrics_cpu_total_mean_p99", "system_metrics_memory_device_mean_p50", "system_metrics_memory_device_mean_p75", "system_metrics_memory_device_mean_p90", "system_metrics_memory_device_mean_p95", "system_metrics_memory_device_mean_p99", "rendering_metrics_fps_mean_p50", "rendering_metrics_fps_mean_p75", "rendering_metrics_fps_mean_p90", "rendering_metrics_fps_mean_p95", "rendering_metrics_fps_mean_p99", "http_response_4xx_percentage", "http_response_5xx_percentage" ] }, "direction": { "type": "string", "description": "The direction to sort the span groups by", "enum": [ "desc", "asc" ] }, "per_page": { "type": "integer", "description": "the number of results per page" }, "offset": { "type": "integer", "description": "the offset for the next page of results" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." }, "starred_only": { "type": "boolean", "description": "Whether to only return Span Groups the requesting user has starred." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_starred\_span\_groups List the starred Span Group descriptions **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ------------------------------------------------------ | | `project_id` | string | Yes | — | The ID of the project to which the Span Groups belong. | | `categories` | string\[] | No | — | The performance categories of the Span Groups. | | `per_page` | integer | No | — | the number of results per page | | `offset` | integer | No | — | the offset for the next page of results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the project to which the Span Groups belong." }, "categories": { "type": "array", "items": { "type": "string", "enum": [ "app_start", "view_load", "network", "page_load", "route_change", "full_page_load", "navigation", "custom" ] }, "description": "The performance categories of the Span Groups." }, "per_page": { "type": "integer", "description": "the number of results per page" }, "offset": { "type": "integer", "description": "the offset for the next page of results" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_project\_trace\_fields List the Trace Fields on a project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Trace Field belongs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Trace Field belongs." } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_list\_release\_group\_releases List Releases on a Release Group **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------- | | `release_group_id` | string | Yes | — | ID of release group to list releases for | | `per_page` | number | No | — | how many results to return per page | | `page_token` | string | No | — | value from the next relation in the Link response header to obtain the next page of results | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "release_group_id": { "type": "string", "description": "ID of release group to list releases for" }, "per_page": { "type": "number", "description": "how many results to return per page" }, "page_token": { "type": "string", "description": "value from the next relation in the Link response header to obtain the next page of results" } }, "required": [ "PCID", "release_group_id" ] } ``` *** ## bugsnag\_projects\_list\_spans\_by\_span\_group\_id List Spans for a Span Group by ID **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the spans belong. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | | `filters` | object\[] | No | — | The current filters that are being applied. | | `sort` | string | No | — | The field to sort the results by. | | `direction` | string | No | — | The direction to sort the results by. | | `per_page` | integer | No | — | The number of results to return per page. Defaults to 20. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the spans belong." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." }, "filters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Identifier that is used as the key when filtering by this field." }, "filter_values": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "match_type": { "type": "string", "description": "- eq - Filter for items that match the value - ne - Filter for items that don't match the value - lt - Filter for items that are less than the value - gt - Filter for items that are greater than the value - empty - Filter for items that are not populated or missing " } } }, "description": "The values to filter by." } }, "required": [ "key" ] }, "description": "The current filters that are being applied." }, "sort": { "type": "string", "description": "The field to sort the results by.", "enum": [ "duration", "timestamp", "full_page_load_lcp", "full_page_load_fid", "full_page_load_cls", "full_page_load_ttfb", "full_page_load_fcp", "rendering_slow_frame_percentage", "rendering_frozen_frame_percentage", "system_metrics_cpu_total_mean", "system_metrics_memory_device_mean", "rendering_metrics_fps_mean", "rendering_metrics_fps_minimum", "rendering_metrics_fps_maximum", "http_response_code" ] }, "direction": { "type": "string", "description": "The direction to sort the results by.", "enum": [ "asc", "desc" ] }, "per_page": { "type": "integer", "description": "The number of results to return per page. Defaults to 20." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_list\_spans\_by\_trace\_id List Spans for a Trace **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `project_id` | string | Yes | — | The ID of the Project to which the spans belong. | | `trace_id` | string | Yes | — | The ID of the Trace to which the spans belong. | | `from` | string | Yes | — | Beginning of window to return spans from. | | `to` | string | Yes | — | End of window to return spans from. | | `target_span_id` | string | No | — | The 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_page` | integer | No | — | The number of results to return per page. Defaults to 20. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the spans belong." }, "trace_id": { "type": "string", "description": "The ID of the Trace to which the spans belong." }, "from": { "type": "string", "description": "Beginning of window to return spans from." }, "to": { "type": "string", "description": "End of window to return spans from." }, "target_span_id": { "type": "string", "description": "The 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_page": { "type": "integer", "description": "The number of results to return per page. Defaults to 20." } }, "required": [ "PCID", "project_id", "trace_id", "from", "to" ] } ``` *** ## bugsnag\_projects\_replace\_project\_error\_assignment\_rules Replace the ErrorAssignmentRules on a project **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the ErrorAssignmentRule belongs. | | `assignment_rules` | object\[] | No | — | Assignment Rules | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the ErrorAssignmentRule belongs." }, "assignment_rules": { "type": "array", "items": { "type": "object", "properties": { "assignee": { "type": "object", "description": "The assignee value" }, "pattern": { "type": "object", "description": "The pattern value" }, "comment": { "type": "string", "description": "Freeform text about the rule." } }, "required": [ "assignee", "pattern" ] }, "description": "Assignment Rules" } }, "required": [ "PCID", "project_id" ] } ``` *** ## bugsnag\_projects\_update\_project Update a Project **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the project | | `collaborator_ids` | string\[] | No | — | If 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_versions` | any\[] | No | — | A list of app versions whose events will be [discarded](https://docs.bugsnag.com/product/event-usage/#discard-by-app-version) if received for the Project. Supports [regular expressions](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Special_characters_meaning_in_regular_expressions) and [semver ranges](https://github.com/npm/node-semver#ranges). Errors matching these versions won't be processed by Bugsnag, and you won't receive notifications about them. | | `discarded_errors` | any\[] | No | — | A list of Error classes whose events will be [discarded](https://docs.bugsnag.com/product/event-usage/#discard-by-error-class) if received for the Project. Errors with these classes won't be processed by Bugsnag, and you won't receive notifications about them. | | `global_grouping` | any\[] | No | — | A 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_browsers` | boolean | No | — | Whether the Events in the Project will be ignored if they originate from old web browsers. Relevant to JavaScript Projects only. | | `ignored_browser_versions` | object | No | — | Relevant 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_grouping` | any\[] | No | — | A 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. | | `name` | string | No | — | The name value | | `resolve_on_deploy` | boolean | No | — | If 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_whitelist` | any\[] | No | — | When 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. | ````json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the project" }, "collaborator_ids": { "type": "array", "items": { "type": "string" }, "description": "If 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_versions": { "type": "array", "description": "A list of app versions whose events will be [discarded](https://docs.bugsnag.com/product/event-usage/#discard-by-app-version) if received for the Project. Supports [regular expressions](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/RegExp#Special_characters_meaning_in_regular_expressions) and [semver ranges](https://github.com/npm/node-semver#ranges). Errors matching these versions won't be processed by Bugsnag, and you won't receive notifications about them." }, "discarded_errors": { "type": "array", "description": "A list of Error classes whose events will be [discarded](https://docs.bugsnag.com/product/event-usage/#discard-by-error-class) if received for the Project. Errors with these classes won't be processed by Bugsnag, and you won't receive notifications about them." }, "global_grouping": { "type": "array", "description": "A 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_browsers": { "type": "boolean", "description": "Whether the Events in the Project will be ignored if they originate from old web browsers. Relevant to JavaScript Projects only." }, "ignored_browser_versions": { "type": "object", "description": "Relevant 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_grouping": { "type": "array", "description": "A 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." }, "name": { "type": "string", "description": "The name value" }, "resolve_on_deploy": { "type": "boolean", "description": "If 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_whitelist": { "type": "array", "description": "When 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." } }, "required": [ "PCID", "project_id" ] } ```` *** ## bugsnag\_projects\_update\_project\_event\_field\_by\_display\_id Update a custom Event Field **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | ID of the Project | | `display_id` | string | Yes | — | human friendly ID for the EventField | | `filter_options` | object | Yes | — | Filter Options | | `path` | string | Yes | — | [Path](https://docs.bugsnag.com/product/custom-filters/advanced-custom-filters/#custom-filter-path) to locate the relevant data inside an Event data structure | | `pivot_options` | object | No | — | Pivot Options | | `reindex` | boolean | No | — | Whether to reindex historical events for this field | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "ID of the Project" }, "display_id": { "type": "string", "description": "human friendly ID for the EventField" }, "filter_options": { "type": "object", "description": "Filter Options", "properties": { "name": { "type": "string", "description": "Human readable name for the filter" } } }, "path": { "type": "string", "description": "[Path](https://docs.bugsnag.com/product/custom-filters/advanced-custom-filters/#custom-filter-path) to locate the relevant data inside an Event data structure" }, "pivot_options": { "type": "object", "description": "Pivot Options", "properties": { "name": { "type": "string", "description": "Human readable display name of the pivot." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Additional fields that are displayed in the pivot tab, for example the users pivot displays user name and email in addition to ID." }, "summary": { "type": "boolean", "description": "Whether this field is displayed in the error summary section of the dashboard" }, "values": { "type": "boolean", "description": "Whether this field is displayed as a pivot tab in the dashboard" }, "cardinality": { "type": "boolean", "description": "Whether the unique values of this field are calculated" }, "average": { "type": "boolean", "description": "Whether an average value of this field is calculated" } } }, "reindex": { "type": "boolean", "description": "Whether to reindex historical events for this field" } }, "required": [ "PCID", "project_id", "display_id", "filter_options", "path" ] } ``` *** ## bugsnag\_projects\_update\_project\_network\_grouping\_ruleset Update a Project's Network Grouping Ruleset **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ---------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to retrieve the endpoints for | | `endpoints` | string\[] | Yes | — | The URL patterns by which network spans are grouped. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to retrieve the endpoints for" }, "endpoints": { "type": "array", "items": { "type": "string" }, "description": "The URL patterns by which network spans are grouped." } }, "required": [ "PCID", "project_id", "endpoints" ] } ``` *** ## bugsnag\_projects\_update\_project\_span\_group Update Span Group **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `project_id` | string | Yes | — | The ID of the Project to which the Span Group belongs. | | `id` | string | Yes | — | The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group. | | `is_starred` | boolean | No | — | whether or not the Span Group is starred by the user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "string", "description": "The ID of the Project to which the Span Group belongs." }, "id": { "type": "string", "description": "The [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding) ID of the Span Group." }, "is_starred": { "type": "boolean", "description": "whether or not the Span Group is starred by the user." } }, "required": [ "PCID", "project_id", "id" ] } ``` *** ## bugsnag\_projects\_update\_release\_group Update a Release Group **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------------- | | `id` | string | Yes | — | ID of release group to update | | `visible` | boolean | Yes | — | the updated visibility | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of release group to update" }, "visible": { "type": "boolean", "description": "the updated visibility" } }, "required": [ "PCID", "id", "visible" ] } ```