Skip to content
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.

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

[Enhancement] Prompt user if incident query returns a large dataset #52

Closed
giranm opened this issue Mar 1, 2022 · 2 comments
Closed
Labels
enhancement New feature or request
Milestone

Comments

@giranm
Copy link
Owner

giranm commented Mar 1, 2022

Summary

PagerDuty's REST API pagination currently supports up to a maximum of 10,000 records returned.
When querying for incidents (particularly over +1000 results), this can impact the user experience of:

  • Fetching incident notes due to current API limitations (e.g. initial notes are fetched sequentially)
  • Bulk update of incidents (acknowledge, resolve, etc) can be slow to manage

To advise the user that a large incident dataset will be returned, PagerDuty Live should have the capability of checking what the query would return, and then prompting the user to continue if it exceeds a predefined limit of incidents.

Example API Query

GET: https://api.pagerduty.com/incidents?limit=1&total=true

{
    "incidents": [
        {
            "incident_number": 18082,
            "title": "Warning: High Response Time Detected",
            "description": "Warning: High Response Time Detected"
            ...
        }
    ],
    "limit": 1,
    "offset": 0,
    "total": 409,
    "more": true
}

The total field can then be used to prompt the user if the entire dataset should be downloaded.

@giranm giranm added the enhancement New feature or request label Mar 1, 2022
@giranm giranm added this to the Beta milestone Mar 1, 2022
@giranm giranm moved this to Todo in PagerDuty Live Mar 6, 2022
@giranm
Copy link
Owner Author

giranm commented Mar 12, 2022

Another route to consider is redirecting the user to the main Global Search page with the same query parameters.

https://subdomain.pagerduty.com/search/?startDate=2022-03-01&endDate=2022-03-11&searchString=error&searchType[]=incident&service[]=PABCXYZ&sortBy=relevance&team[]=PXYZABC

NB - searchString must be populated otherwise no incidents will be returned. Need to identify if a wildcard can be used.

@giranm
Copy link
Owner Author

giranm commented Jul 21, 2022

Closing issue since this was addressed in #127.

@giranm giranm closed this as completed Jul 21, 2022
Repository owner moved this from Todo to Done in PagerDuty Live Jul 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

1 participant