update public API docs subpage ordering (#4833 )

# What this PR does

**Before**
![Screenshot 2024-08-15 at 13 55
40](https://github.com/user-attachments/assets/847afb34-d8d1-46f8-b6b4-fba2b6a469e0)

**After**
<img width="295" alt="Screenshot 2024-08-15 at 15 20 41"
src="https://github.com/user-attachments/assets/6cfef429-fde6-4b0d-81af-f59e97adaaaa">

2024-08-15 19:29:56 +00:00

1.9 KiB

Raw Blame History

canonical

title

weight

refs

https://grafana.com/docs/oncall/latest/oncall-api-reference/user_groups/

OnCall user groups HTTP API

pagination

pattern	destination
/docs/oncall/	/docs/oncall/<ONCALL_VERSION>/oncall-api-reference/#pagination

pattern	destination
/docs/grafana-cloud/	/docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/#pagination

OnCall user groups HTTP API

List user groups

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

The above command returns JSON structured in the following way:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "GPFAPH7J7BKJB",
      "type": "slack_based",
      "slack": {
        "id": "MEOW_SLACK_ID",
        "name": "Meow Group",
        "handle": "meow_group"
      }
    }
  ],
  "current_page_number": 1,
  "page_size": 50,
  "total_pages": 1
}

Note

: The response is paginated. You may need to make multiple requests to get all records.

Parameter	Unique	Description
`id`	Yes	User Group ID
`type`	No	Slack-defined user groups
`slack`	No	Metadata retrieved from Slack.

HTTP request

GET {{API_URL}}/api/v1/user_groups/

1.9 KiB Raw Blame History

OnCall user groups HTTP API

List user groups

1.9 KiB

Raw Blame History