Updating Cypress Cloud API spec #5911
Conversation
Part of the big Enterprise Reporting release that launched the end of August.
| - projects. Optional, and accepts the name of your Cypress project. The project name should be URL encoded. You can | ||
| pass as many projects parameters as needed. | ||
|
|
||
| For example, `&projects=project%20a&projects=test123` |
There was a problem hiding this comment.
It’d be nice to show the desired state of these without the encoding and everything. Like “For example, if you want to see reporting for projects with the name Dashboard and design-system, use the following query param”. Otherwise I’m trying to parse what the desired state was for the time formats and the project names from just the url and removing the encoding, but I didn’t even know what the names of the projects were to begin with.
There was a problem hiding this comment.
incorporated. Coming in the next commit
|
|
||
| For example, `?start_date=2024-01-01` or `?start_date=2024-01-01T12%3A30%3A00` | ||
|
|
||
| - end_date. Optional and should be passed in either yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss format. |
There was a problem hiding this comment.
I suppose if you don’t pass this then it defaults to now? May be good to mention.
There was a problem hiding this comment.
incorporated. Coming in the next commit
|
|
||
| - project_name | ||
| - flaky_test_count | ||
| - build_count |
There was a problem hiding this comment.
It’s a bit weird that this is called ‘build count’ when the entirety of our product always refers to these as runs.
There was a problem hiding this comment.
incorporated. Coming in the next commit. Cleaning up build vs run.
| Example: | ||
| https://cloud.cypress.io/enterprise-reporting/report?token=YOUR-API-KEY&report_id=spec-details&export_format=csv&start_date=2024-01-01 | ||
|
|
||
| ### Individual test results with errors |
There was a problem hiding this comment.
Is this for errors or failures? Errors are completely different than failures.
There was a problem hiding this comment.
incorporated. Coming in the next commit
| https://cloud.cypress.io/enterprise-reporting/report?token=YOUR-API-KEY&report_id=test-details&export_format=csv&start_date=2024-01-01 | ||
|
|
||
| The report_id is: `COMING-SOON` | ||
| ### Average build duration over time |
There was a problem hiding this comment.
Again would refer to this as run. But seems this is all mixed up in the implementation I guess.
There was a problem hiding this comment.
incorporated. Coming in the next commit. Cleaning up build vs run.
| - mdn_pass_build_duration (median) | ||
| - min_pass_build_duration (min) | ||
| - max_pass_build_duration (max) | ||
| - day |
There was a problem hiding this comment.
changed "build" to "run".. Also, to answer the question, any of the data that is reported "over time" provides a pivot to the day and week. Easily allows reporting systems to consume the data for visual reporting over time.
| Example: | ||
| https://cloud.cypress.io/enterprise-reporting/report?token=YOUR-API-KEY&report_id=flaky-test-details&export_format=csv&start_date=2024-01-01 | ||
|
|
||
| ### Top flaky per project |
There was a problem hiding this comment.
Flaky tests. Incorporated in the next commit.
fixing the term "run" vs "build" where possible. Also the examples in the query parameter section easier to understand. Adding clarity where requested by the team.
Adding more description about how flaky rates and fail rates are presented
indicate we're pivoting this data based on passing runs. Errored or even failed runs can impact the metrics
Move it inline with the other query string params now available.
danjohansenconsulting
deleted the
enterprise-reporting-apis_aug-release
branch
|
enterprise reporting APIs that were released for Cloud in August 2024 |
2 participants
Part of the big Enterprise Reporting release that launched the end of August.