augment API response pagination attributes (#2471 )

# What this PR does

This PR:
- adds a few attributes to paginated API responses
- removes channel filter "send demo alert" internal API endpoint + tests
(this endpoint was marked as deprecated + not consumed by the web UI)

With the new paginated API response schema, the web UI will no longer
need to:
- hardcode `ITEMS_PER_PAGE` for each table
- manually calculate total number of pages

(these two things ☝️ will be done in
https://github.com/grafana/oncall/issues/2476)

For `GET /api/internal/v1/alertgroups` the response will now look like
this:
```diff
{
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>
}
```

For all other paginated API responses, the response will now look like:
```diff
{
    "count": <int>,
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>,
++  "current_page_number": <int>,
++  "total_pages": <int>
}
```

## TODO
- [x] update public API docs to include these new attributes

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)

2023-07-14 11:19:40 -04:00

2.7 KiB

Raw Blame History

canonical	title	weight
https://grafana.com/docs/oncall/latest/oncall-api-reference/alerts/	Alerts HTTP API	100

List Alerts

curl "{{API_URL}}/api/v1/alerts/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "AA74DN7T4JQB6",
      "alert_group_id": "I68T24C13IFW1",
      "created_at": "2020-05-11T20:08:43Z",
      "payload": {
        "state": "alerting",
        "title": "[Alerting] Test notification",
        "ruleId": 0,
        "message": "Someone is testing the alert notification within Grafana.",
        "ruleUrl": "{{API_URL}}/",
        "ruleName": "Test notification",
        "evalMatches": [
          {
            "tags": null,
            "value": 100,
            "metric": "High value"
          },
          {
            "tags": null,
            "value": 200,
            "metric": "Higher Value"
          }
        ]
      }
    },
    {
      "id": "AR9SSYFKE2PV7",
      "alert_group_id": "I68T24C13IFW1",
      "created_at": "2020-05-11T20:07:54Z",
      "payload": {
        "state": "alerting",
        "title": "[Alerting] Test notification",
        "ruleId": 0,
        "message": "Someone is testing the alert notification within Grafana.",
        "ruleUrl": "{{API_URL}}/",
        "ruleName": "Test notification",
        "evalMatches": [
          {
            "tags": null,
            "value": 100,
            "metric": "High value"
          },
          {
            "tags": null,
            "value": 200,
            "metric": "Higher Value"
          }
        ]
      }
    },
    {
      "id": "AWJQSGEYYUFGH",
      "alert_group_id": "I68T24C13IFW1",
      "created_at": "2020-05-11T20:06:58Z",
      "payload": {
        "state": "alerting",
        "title": "[Alerting] Test notification",
        "ruleId": 0,
        "message": "Someone is testing the alert notification within Grafana.",
        "ruleUrl": "{{API_URL}}/",
        "ruleName": "Test notification",
        "evalMatches": [
          {
            "tags": null,
            "value": 100,
            "metric": "High value"
          },
          {
            "tags": null,
            "value": 200,
            "metric": "Higher Value"
          }
        ]
      }
    }
  ],
  "current_page_number": 1,
  "page_size": 50,
  "total_pages": 1
}

The following available filter parameters should be provided as GET arguments:

id
alert_group_id
search—string-based inclusion search by alert payload

HTTP request

GET {{API_URL}}/api/v1/alerts/

2.7 KiB Raw Blame History

List Alerts

2.7 KiB

Raw Blame History