bugsnag Projects API
Access and manage projects within an organization. Projects represent individual applications being monitored by Bugsnag.
Operations 47
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/organizations/{organization_id}/projects
List an organization's projects · List organization projects
#
Ask an LLM
“What projects are in my BugSnag organization?”
“Can I sort my organization's projects by name or creation date?”
Tell an agent
List projects in organization {organization_id}.
List organization {organization_id}'s projects sorted by {sort} {direction}.
Ask an LLM
“How do I create a new project and get its API key?”
“What project type do I pick when creating a project for my app's platform?”
Tell an agent
Create a {type} project called {name} in organization {organization_id}.
Set up project {name} of type {type} under organization {organization_id} and return its API key.
Ask an LLM
“What is the notifier API key for my project?”
“How do I see a project's type and configuration?”
Tell an agent
Show project {project_id}.
Get the API key and settings for project {project_id}.
Ask an LLM
“How do I rename a project?”
“Can I discard errors from old app versions I no longer support?”
Tell an agent
Rename project {project_id} to {name}.
Discard events from app versions {discarded_app_versions} in project {project_id}.
Ask an LLM
“Can I delete a project and everything in it?”
“What data is lost when a project is deleted?”
Tell an agent destructive · confirm first
Delete project {project_id}.
Permanently remove project {project_id} with all its errors and events.
DELETE
/projects/{project_id}/api_key
Regenerate a project's notifier API key · Regenerate a project API key
#
Ask an LLM
“How do I rotate my project's API key after it was exposed?”
“Does the old project API key stop working immediately when regenerated?”
Tell an agent destructive · confirm first
Regenerate the API key for project {project_id}.
Rotate project {project_id}'s notifier API key.
DELETE
/projects/{project_id}/upload_api_key
Regenerate a project's upload API key · Regenerate a Project's upload API key
#
Ask an LLM
“How do I rotate the key used for uploading source maps and ProGuard files?”
“Can I regenerate only the symbol upload key without touching the notifier key?”
Tell an agent destructive · confirm first
Rotate the source map and symbol upload key on project {project_id}.
Issue a new symbol upload key for project {project_id}.
POST
/projects/{project_id}/event_fields
Create a custom event field · Create a custom Event Field
#
Ask an LLM
“How do I make a custom metadata value filterable in my project?”
“Can a new custom event field be reindexed against existing events?”
Tell an agent
Create a custom event field for path {path} in project {project_id} with filter options {filter_options}.
Add a pivotable custom field at {path} to project {project_id} using filter options {filter_options} and pivot options {pivot_options}.
PATCH
/projects/{project_id}/event_fields/{display_id}
Update a custom event field · Update a custom Event Field
#
Ask an LLM
“How do I change the filter options on an existing custom event field?”
“Can I point an existing custom field at a different metadata path?”
Tell an agent
Update custom field {display_id} in project {project_id} to path {path} with filter options {filter_options}.
Change custom field {display_id} in project {project_id} to path {path}, filter options {filter_options}, and reindex {reindex}.
DELETE
/projects/{project_id}/event_fields/{display_id}
Delete a custom event field · Delete a custom Event Field
#
Ask an LLM
“Can I remove a custom event field I no longer filter on?”
“How do I delete a custom field from a project?”
Tell an agent destructive · confirm first
Delete custom event field {display_id} from project {project_id}.
Remove the custom field {display_id} in project {project_id}.
GET
/projects/{project_id}/release_groups
List a project's release groups · List Release Groups on a Project
#
Ask an LLM
“What release groups does my project have in production?”
“Can I list only the top or visible release groups for a stage?”
Tell an agent
List release groups for project {project_id} in stage {release_stage_name}.
Show only top release groups for project {project_id} in {release_stage_name}: {top_only}.
Ask an LLM
“What is in a specific release group?”
“How do I look up one release group by ID?”
Tell an agent
Show release group {id}.
Get the details of release group {id}.
Ask an LLM
“Can I hide a release group from my releases dashboard?”
“How do I make a hidden release group visible again?”
Tell an agent
Set release group {id} visible to {visible}.
Hide release group {id} by setting visible {visible}.
GET
/release_groups/{release_group_id}/releases
List releases in a release group · List Releases on a Release Group
#
Ask an LLM
“Which individual releases belong to a release group?”
“Can I page through the builds inside one release group?”
Tell an agent
List releases in release group {release_group_id}.
Show {per_page} releases per page from release group {release_group_id}.
POST
/projects/{project_id}/event_data_requests
Request a project event data export · Create an event data request
#
Ask an LLM
“How do I export all event data for one project?”
“Can I export a single project's events matching a filter for a data access request?”
Tell an agent
Start an event data export for project {project_id} with filters {filters}.
Request a {report_type} export of project {project_id} events matching {filters}.
GET
/projects/{project_id}/event_data_requests/{id}
Check a project export's status · Check the status of an event data request
#
Ask an LLM
“Is my project's event data export ready yet?”
“How do I get the download link for a finished project export?”
Tell an agent
Check export request {id} for project {project_id}.
Get the status of project {project_id} data request {id}.
POST
/projects/{project_id}/event_data_deletions
Request deletion of a project's events · Create an event deletion request
#
Ask an LLM
“How do I delete a specific user's events from one project?”
“Do name and email filters in a project deletion use substring matching?”
Tell an agent destructive · confirm first
Request deletion of events matching {filters} in project {project_id}.
Delete project {project_id} events matching {filters} with skip confirmation {skip_confirmation}.
POST
/projects/{project_id}/event_data_deletions/{id}/confirm
Confirm a project event deletion · Confirm an event deletion request
#
Ask an LLM
“How do I confirm a pending event deletion in a project?”
“Does a project event deletion run before I confirm it?”
Tell an agent destructive · confirm first
Confirm deletion request {id} in project {project_id}.
Go ahead with project {project_id} event deletion {id}.
GET
/projects/{project_id}/event_data_deletions/{id}
Check a project deletion's status · Check the status of an event deletion request
#
Ask an LLM
“Has my project event deletion completed?”
“How do I track progress of a deletion request in a project?”
Tell an agent
Check deletion request {id} in project {project_id}.
Show the status of project {project_id} event deletion {id}.
GET
/projects/{project_id}/feature_flags
List a project's feature flags · List Feature Flags on a Project
#
Ask an LLM
“Which feature flags have been seen in my production release stage?”
“Can I list feature flags first seen after a certain date?”
Tell an agent
List feature flags in project {project_id} for stage {release_stage_name}.
Search feature flags in project {project_id} stage {release_stage_name} for {q}.
GET
/projects/{project_id}/feature_flag_summaries
List feature flag summaries · List Feature Flag Summaries for a Project
#
Ask an LLM
“Can I get a lightweight list of feature flag names for a project?”
“How do I search feature flag summaries by name?”
Tell an agent
List feature flag summaries for project {project_id}.
Find feature flag summaries in project {project_id} matching {q}.
Ask an LLM
“What do we know about a single feature flag in production?”
“Can I include a variant summary when fetching one feature flag?”
Tell an agent
Show feature flag {id} in project {project_id} for stage {release_stage_name}.
Get flag {id} in project {project_id} stage {release_stage_name} with variant summary {include_variant_summary}.
Ask an LLM
“Can I remove a retired feature flag from a project?”
“How do I delete a feature flag record?”
Tell an agent destructive · confirm first
Delete feature flag {id} from project {project_id}.
Remove the retired flag {id} in project {project_id}.
GET
/projects/{project_id}/feature_flags/{id}/error_overview
Get errors linked to a feature flag · Get a Feature Flag's Error Overview
#
Ask an LLM
“Is a feature flag causing new errors in production?”
“How many errors occur while a particular flag is on?”
Tell an agent
Show the error overview for feature flag {id} in project {project_id} stage {release_stage_name}.
Check whether flag {id} in project {project_id} is driving errors in {release_stage_name}.
GET
/projects/{project_id}/feature_flags/{id}/variants/error_overview
Compare errors across flag variants · Get a Feature Flag Variant's Error Overview
#
Ask an LLM
“Which variant of an experiment produces more errors?”
“Can I compare error rates for specific feature flag variants?”
Tell an agent
Compare errors for variants {variant_ids} of flag {id} in project {project_id} stage {release_stage_name}.
Show the variant error overview for flag {id} in project {project_id}, variants {variant_ids}, stage {release_stage_name}.
GET
/projects/{project_id}/feature_flags/{id}/variants
List a flag's variants by flag ID · List Variants on a Feature Flag by ID
#
Ask an LLM
“What variants exist for a feature flag when I have its ID?”
“Can I search a flag's variants by value?”
Tell an agent
List variants of feature flag {id} in project {project_id}.
Search variants of flag ID {id} in project {project_id} for {q}.
GET
/projects/{project_id}/feature_flags/by_name/{name}/variants
List a flag's variants by flag name · List Variants on a Feature Flag by name
#
Ask an LLM
“Can I look up a feature flag's variants using its name instead of an ID?”
“Which variants of a named flag appeared in production?”
Tell an agent
List variants of the flag named {name} in project {project_id}.
Show variants for flag {name} in project {project_id} in stage {release_stage_name}.
Ask an LLM
“How do I pin a feature flag to the top of my list?”
“Can I star flags I want to keep an eye on?”
Tell an agent
Star feature flag {feature_flag_id} in project {project_id}.
Add flag {feature_flag_id} to my starred flags for project {project_id}.
DELETE
/user/projects/{project_id}/starred_feature_flags/{id}
Unstar a feature flag · Unstar a Feature Flag
#
Ask an LLM
“How do I unstar a feature flag?”
“Can I remove a flag from my starred list?”
Tell an agent destructive · confirm first
Unstar feature flag {id} in project {project_id}.
Take flag {id} off my starred list in project {project_id}.
PUT
/projects/{project_id}/error_assignment_rules
Replace a project's error assignment rules · Replace the ErrorAssignmentRules on a project
#
Ask an LLM
“How do I automatically assign new errors to the right person?”
“What happens to existing assignment rules if I send an empty list?”
Tell an agent
Replace project {project_id}'s error assignment rules with {assignment_rules}.
Clear all error assignment rules on project {project_id}.
GET
/projects/{project_id}/span_groups
List a project's span groups · List Span Groups on a Project
#
Ask an LLM
“Which operations are being tracked for performance in my project?”
“Can I list only my starred span groups sorted by duration?”
Tell an agent
List span groups in project {project_id}.
List span groups in project {project_id} sorted by {sort}, starred only {starred_only}.
Ask an LLM
“What are the performance statistics for one span group?”
“Why would a span group come back with empty statistics?”
Tell an agent
Show span group {id} in project {project_id}.
Get stats for span group {id} in project {project_id} filtered by {filters}.
Ask an LLM
“How do I star a span group so I can find it quickly?”
“Can I unstar a span group I no longer watch?”
Tell an agent
Set span group {id} in project {project_id} starred to {is_starred}.
Star span group {id} in project {project_id} (is_starred {is_starred}).
GET
/projects/{project_id}/span_group_summaries
List span group summaries · List Span Group Summaries for a Project
#
Ask an LLM
“Can I get a compact summary of every span group in a project?”
“How do I page through span group summaries with a filter?”
Tell an agent
List span group summaries for project {project_id}.
Summarize span groups in project {project_id} matching {filters}.
GET
/projects/{project_id}/span_groups/{id}/timeline
Get a span group's performance over time · Get a Span Group's timeline
#
Ask an LLM
“How has a span group's duration changed over time?”
“Can I chart the timeline of one span group?”
Tell an agent
Show the timeline for span group {id} in project {project_id}.
Chart span group {id} over time in project {project_id} filtered by {filters}.
GET
/projects/{project_id}/span_groups/{id}/distribution
Get a span group's duration distribution · Get a Span Group's distribution
#
Ask an LLM
“What does the duration distribution look like for a span group?”
“How spread out are the timings of one operation?”
Tell an agent
Show the duration distribution of span group {id} in project {project_id}.
Get the histogram of timings for span group {id} in project {project_id} matching {filters}.
GET
/projects/{project_id}/starred_span_groups
List my starred span groups · List the starred Span Group descriptions
#
Ask an LLM
“Which span groups have I starred in a project?”
“Can I filter my starred span groups by performance category?”
Tell an agent
List my starred span groups in project {project_id}.
Show my starred span groups in project {project_id} for categories {categories}.
GET
/projects/{project_id}/span_groups/{id}/performance_targets
List a span group's performance targets · List Performance Targets for a Span Group by ID
#
Ask an LLM
“What performance targets are set for a span group?”
“Is a span group meeting its configured target thresholds?”
Tell an agent
List performance targets for span group {id} in project {project_id}.
Show the target thresholds on span group {id} in project {project_id}.
GET
/projects/{project_id}/span_group_categories/{category}/span_groups/{name}/spans
Get spans by span group category and name · Get Spans for a Span Group
#
Ask an LLM
“How do I get spans for a span group when I know its category and name but not its ID?”
“Can I fetch spans for a named network request group?”
Tell an agent
Get spans for span group {name} in category {category} of project {project_id}.
Show the {category} spans named {name} in project {project_id}.
GET
/projects/{project_id}/span_groups/{id}/spans
List spans in a span group by ID · List Spans for a Span Group by ID
#
Ask an LLM
“Can I see the individual spans recorded for a span group ID?”
“How do I sort the spans in a span group by duration?”
Tell an agent
List spans in span group {id} of project {project_id}.
List spans for span group ID {id} in project {project_id} sorted by {sort} {direction}.
GET
/projects/{project_id}/traces/{trace_id}/spans
List a trace's spans in a project · List Spans for a Trace
#
Ask an LLM
“How do I see every span in one trace within a project?”
“What time window do I need to give to fetch a trace's spans?”
Tell an agent
List spans for trace {trace_id} in project {project_id} between {from} and {to}.
Show project {project_id} trace {trace_id} focused on span {target_span_id} from {from} to {to}.
GET
/projects/{project_id}/page_load_span_groups
List page load span groups · List Page Load Span Groups
#
Ask an LLM
“Which pages in my web app load slowest?”
“Can I list only starred page load span groups?”
Tell an agent
List page load span groups in project {project_id}.
List page loads in project {project_id} sorted by {sort}, starred only {starred_only}.
GET
/projects/{project_id}/page_load_span_groups/{id}
Show a page load span group · Show a Page Load Span Group by ID
#
Ask an LLM
“How fast does one particular page load for my users?”
“Can I filter one page load group's metrics?”
Tell an agent
Show page load span group {id} in project {project_id}.
Get page load metrics for group {id} in project {project_id} filtered by {filters}.
GET
/projects/{project_id}/trace_fields
List a project's trace fields · List the Trace Fields on a project
#
Ask an LLM
“Which fields can I filter spans and span groups by?”
“What trace fields are available on my project?”
Tell an agent
List trace fields for project {project_id}.
Show the span filter fields available in project {project_id}.
GET
/projects/{project_id}/network_endpoint_grouping
Get network request grouping rules · List a Project's Network Grouping Ruleset
#
Ask an LLM
“How are my network requests grouped into endpoints for performance?”
“What URL grouping rules does my project use?”
Tell an agent
Show the network grouping ruleset for project {project_id}.
Get project {project_id}'s endpoint grouping rules.
PUT
/projects/{project_id}/network_endpoint_grouping
Set network request grouping rules · Update a Project's Network Grouping Ruleset
#
Ask an LLM
“Can I group network requests with IDs in the URL into one endpoint?”
“How do I change the endpoint patterns used to group network spans?”
Tell an agent
Set project {project_id}'s network grouping endpoints to {endpoints}.
Replace the endpoint grouping rules on project {project_id} with {endpoints}.
GET
/projects/{project_id}/performance_overview
Get a project's performance score · Get Performance Score Overview for Project
#
Ask an LLM
“What is my project's overall performance score?”
“Can I see the performance score for production only?”
Tell an agent
Show the performance score for project {project_id}.
Get project {project_id}'s performance overview in stage {release_stage_name}.