Skip to content

docs(size-analysis): Document status check rules API #17558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cameroncooke wants to merge 3 commits into
base: master
Choose a base branch
from
+12 −0
Open

docs(size-analysis): Document status check rules API #17558

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5d91be
docs(size-analysis): Document status check rules API
cameroncooke Apr 30, 2026
14c475d
docs(size-analysis): Avoid generated API link before schema lands
cameroncooke Apr 30, 2026
24a0fa3
docs(size-analysis): Correct webhook event name
cameroncooke Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/product/size-analysis/integrating-into-ci.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,18 @@ Rules are evaluated independently. If any rule's threshold is exceeded, the stat
- If status checks are **enabled** but **no rules are configured**, checks will post as **neutral** (won't block PRs) but will still show size change information
- If rules are configured, checks will pass or fail based on whether thresholds are exceeded

### Fetching Status Check Rules for External CI

If you're consuming the `preprod_artifact.size_analysis_completed` webhook in your own CI, you can fetch the project's current status check rule config from the Size Analysis status check rules API:

```http
GET /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/size-analysis/status-check-rules/
```

Use this when you want external CI to evaluate the same thresholds that Sentry uses for Size Analysis status checks, without duplicating rule configuration outside Sentry. Once the generated API reference is available, it will document the response shape, filter operators, AND/OR grouping semantics, wildcard matching behavior, and invalid-filter handling.

The endpoint returns the **current project configuration**, not a historical snapshot from when the webhook was emitted. If rules change between webhook delivery and your API request, you'll receive the updated rules.

## Troubleshooting

### Not Seeing Status Checks
Expand Down
Loading