-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add docs for pagination in /api/v2/metrics endpoint (#1829)
Co-authored-by: ci.datadog-api-spec <[email protected]>
- Loading branch information
1 parent
ca2ba6c
commit 4b4a8ae
Showing
15 changed files
with
608 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
...582/Get-a-list-of-metrics-returns-Success-response-with-pagination_2424757361/frozen.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| "2024-12-06T19:12:25.667Z" |
115 changes: 115 additions & 0 deletions
115
...2/Get-a-list-of-metrics-returns-Success-response-with-pagination_2424757361/recording.har
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| { | ||
| "log": { | ||
| "_recordingName": "Metrics/Get a list of metrics returns \"Success\" response with pagination", | ||
| "creator": { | ||
| "comment": "persister:fs", | ||
| "name": "Polly.JS", | ||
| "version": "6.0.5" | ||
| }, | ||
| "entries": [ | ||
| { | ||
| "_id": "8ebd8c6fc837a7c834914fdf3447ba1d", | ||
| "_order": 0, | ||
| "cache": {}, | ||
| "request": { | ||
| "bodySize": 0, | ||
| "cookies": [], | ||
| "headers": [ | ||
| { | ||
| "_fromType": "array", | ||
| "name": "accept", | ||
| "value": "application/json" | ||
| } | ||
| ], | ||
| "headersSize": 526, | ||
| "httpVersion": "HTTP/1.1", | ||
| "method": "GET", | ||
| "queryString": [ | ||
| { | ||
| "name": "page", | ||
| "value": { | ||
| "size": "1" | ||
| } | ||
| } | ||
| ], | ||
| "url": "https://api.datadoghq.com/api/v2/metrics?page%5Bsize%5D=2" | ||
| }, | ||
| "response": { | ||
| "bodySize": 1644, | ||
| "content": { | ||
| "mimeType": "application/json", | ||
| "size": 1644, | ||
| "text": "{\"data\":[{\"type\":\"metrics\",\"id\":\"datadog.event.tracking.indexation.audit.events\"},{\"type\":\"metrics\",\"id\":\"datadog.estimated_usage.events.ingested_events\"}],\"meta\":{\"pagination\":{\"cursor\":null,\"next_cursor\":\"6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d\",\"limit\":1,\"type\":\"cursor_limit\"}},\"links\":{\"self\":\"https://api.datadoghq.com/api/v2/metrics?page[size]=1\",\"last\":null,\"next\":\"https://api.datadoghq.com/api/v2/metrics?page[cursor]=6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d\",\"prev\":null,\"first\":\"https://api.datadoghq.com/api/v2/metrics?page[size]=1\"}}\n" | ||
| }, | ||
| "cookies": [], | ||
| "headers": [ | ||
| { | ||
| "name": "content-type", | ||
| "value": "application/json" | ||
| } | ||
| ], | ||
| "headersSize": 653, | ||
| "httpVersion": "HTTP/1.1", | ||
| "redirectURL": "", | ||
| "status": 200, | ||
| "statusText": "OK" | ||
| }, | ||
| "startedDateTime": "2024-12-06T19:12:25.678Z", | ||
| "time": 167 | ||
| }, | ||
| { | ||
| "_id": "71ffa01cdf3d18b9be9f8b8bdf93efa0", | ||
| "_order": 0, | ||
| "cache": {}, | ||
| "request": { | ||
| "bodySize": 0, | ||
| "cookies": [], | ||
| "headers": [ | ||
| { | ||
| "_fromType": "array", | ||
| "name": "accept", | ||
| "value": "application/json" | ||
| } | ||
| ], | ||
| "headersSize": 1168, | ||
| "httpVersion": "HTTP/1.1", | ||
| "method": "GET", | ||
| "queryString": [ | ||
| { | ||
| "name": "page", | ||
| "value": { | ||
| "cursor": "6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d", | ||
| "size": "1" | ||
| } | ||
| } | ||
| ], | ||
| "url": "https://api.datadoghq.com/api/v2/metrics?page%5Bsize%5D=2&page%5Bcursor%5D=6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d" | ||
| }, | ||
| "response": { | ||
| "bodySize": 2922, | ||
| "content": { | ||
| "mimeType": "application/json", | ||
| "size": 2922, | ||
| "text": "{\"data\":[{\"type\":\"metrics\",\"id\":\"datadog.estimated_usage.synthetics.api_test_runs\"}],\"meta\":{\"pagination\":{\"cursor\":\"6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d\",\"next_cursor\":\"6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a32557563336c756447686c64476c6a6379356863476c666447567a644639796457357a4c4445754d44417a4e6a4d795a5373774e673d3d\",\"limit\":1,\"type\":\"cursor_limit\"}},\"links\":{\"self\":\"https://api.datadoghq.com/api/v2/metrics?page[cursor]=6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a3255755a585a6c626e527a4c6d6c755a32567a6447566b583256325a573530637977324c6a67794e7a677a4e3255724d44593d&page[size]=1\",\"last\":null,\"next\":\"https://api.datadoghq.com/api/v2/metrics?page[cursor]=6354566d64454633525642695631597759323173616d4d784f5768614d6d52355748704265455a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c5752555642526d787355314e756233686c617a56575656526b52465273516c6456526c5a74557a427756574a73525546425155464251554642526c705464316455566b354a5658706e4e574d7863465669565852465657316b576b354962464a566257733156564642516b5a7561453154526b704554315a4f616c5577566b685862456f305455646e6557517a526e6c57525556425155453950546f365a474630595752765a79356c63335270625746305a57526664584e685a32557563336c756447686c64476c6a6379356863476c666447567a644639796457357a4c4445754d44417a4e6a4d795a5373774e673d3d\",\"prev\":null,\"first\":\"https://api.datadoghq.com/api/v2/metrics?page[size]=1\"}}\n" | ||
| }, | ||
| "cookies": [], | ||
| "headers": [ | ||
| { | ||
| "name": "content-type", | ||
| "value": "application/json" | ||
| } | ||
| ], | ||
| "headersSize": 653, | ||
| "httpVersion": "HTTP/1.1", | ||
| "redirectURL": "", | ||
| "status": 200, | ||
| "statusText": "OK" | ||
| }, | ||
| "startedDateTime": "2024-12-06T19:12:25.859Z", | ||
| "time": 121 | ||
| } | ||
| ], | ||
| "pages": [], | ||
| "version": "1.2" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /** | ||
| * Get a list of metrics returns "Success" response with pagination | ||
| */ | ||
|
|
||
| import { client, v2 } from "@datadog/datadog-api-client"; | ||
|
|
||
| const configuration = client.createConfiguration(); | ||
| const apiInstance = new v2.MetricsApi(configuration); | ||
|
|
||
| const params: v2.MetricsApiListTagConfigurationsRequest = { | ||
| pageSize: 2, | ||
| }; | ||
|
|
||
| (async () => { | ||
| try { | ||
| for await (const item of apiInstance.listTagConfigurationsWithPagination( | ||
| params | ||
| )) { | ||
| console.log(item); | ||
| } | ||
| } catch (error) { | ||
| console.error(error); | ||
| } | ||
| })(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.