{ "opencollection": "1.0.0", "info": { "name": "APImetrics", "version": "v2026-09-02" }, "items": [ { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "Project-Calls-Monthly", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/project/analytics/calls-monthly", "headers": [ { "name": "accept", "value": "" }, { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "start_date", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Project-Calls-Monthly" }, { "info": { "name": "Org-Slow-Calls-Daily-Csv", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/analytics/slow-calls-daily", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "thresholds", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Org-Slow-Calls-Daily-Csv" }, { "info": { "name": "Org-Slow-Calls-Monthly", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/analytics/slow-calls-monthly", "headers": [ { "name": "accept", "value": "" } ], "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "thresholds", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Org-Slow-Calls-Monthly" } ] }, { "info": { "name": "API Monitor Statistics", "type": "folder" }, "items": [ { "info": { "name": "Aggregate performance metrics for an API monitor over a window", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/api/:monitor_id/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics for an API monitor over a window.\n\nReturns the requested measures (e.g. mean, p50, p90) per metric, optionally\ngrouped by location and/or time bucket." }, { "info": { "name": "DNS diagnostics for an API monitor over a window", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/api/:monitor_id/stats/dns-diagnostics", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate DNS diagnostics for an API monitor over a window.\n\nReturns a breakdown of observed DNS providers, resolved IPs, CNAME chains,\nNS servers, and mean lookup time, optionally grouped by location and/or\ntime bucket." }, { "info": { "name": "Aggregate performance metrics across all API monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/api/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics across all API monitors in the project.\n\nPair with `group_by=monitor` to get one PerformanceGroup per monitor; with\n`group_by=monitor,interval` for per-monitor time-series. Without a `monitor`\ngrouping, results are a single project-wide aggregate." }, { "info": { "name": "DNS diagnostics across all API monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/api/stats/dns-diagnostics", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate DNS diagnostics across all API monitors in the project.\n\nReturns a breakdown of observed DNS providers, resolved IPs, CNAME chains,\nNS servers, and mean lookup time, optionally grouped by location and/or\ntime bucket." } ] }, { "info": { "name": "Baseline", "type": "folder" }, "items": [ { "info": { "name": "Baseline-Dailies", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/baseline/dailies/:date", "params": [ { "name": "date", "value": "", "type": "path" } ] }, "docs": "Baseline-Dailies" }, { "info": { "name": "Baseline-Hourlies", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/baseline/hourlies", "params": [ { "name": "start", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" } ] }, "docs": "Baseline-Hourlies" } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "Org-Billing-Usage-Counts", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/billing/usage-counts", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "months", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Org-Billing-Usage-Counts" }, { "info": { "name": "Org-Billing-Quota", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/billing/quota", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Org-Billing-Quota" }, { "info": { "name": "Project-Billing-Usage-Counts", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/projects/billing/usage-counts", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "months", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Project-Billing-Usage-Counts" }, { "info": { "name": "Project-Billing-Quota", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/projects/billing/quota", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Project-Billing-Quota" } ] }, { "info": { "name": "Browser Monitor Statistics", "type": "folder" }, "items": [ { "info": { "name": "Aggregate performance metrics for a monitor over a window", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics for a monitor over a window.\n\nReturns the requested measures (e.g. mean, p50, p90) per metric, optionally\ngrouped by location and/or time bucket." }, { "info": { "name": "Aggregate resource-level data from `resource_requests` for a monitor", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id/stats/resources", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate resource-level data from `resource_requests` for a browser monitor.\n\nReturns:\n- `by_type`: per-resource-type breakdown (count, size) suitable for a pie chart.\n- `third_party_timeseries`: 1st-party vs 3rd-party load time per interval bucket\n (empty when no `interval` is supplied)." }, { "info": { "name": "Query the top-N raw page_metrics rows sorted by the chosen metric", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id/stats/sessions", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the top-N raw page_metrics rows sorted by the chosen metric.\n\nPowers the \"worst sessions\" / \"slowest sessions\" list — each row carries\nthe individual result's CWV values, location, and result_id so the client\ncan deep-link to the result detail view." }, { "info": { "name": "Aggregate performance metrics across all browser monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics across all browser monitors in the project.\n\nPair with `group_by=monitor` to get one PerformanceGroup per monitor; with\n`group_by=monitor,interval` for per-monitor time-series. Without a `monitor`\ngrouping, results are a single project-wide aggregate." }, { "info": { "name": "Aggregate resource-level data across all browser monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/stats/resources", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate resource-level data from `resource_requests` across all\nbrowser monitors in the project.\n\nReturns:\n- `by_type`: per-resource-type breakdown (count, size) suitable for a pie chart.\n- `third_party_timeseries`: 1st-party vs 3rd-party load time per interval bucket\n (empty when no `interval` is supplied)." }, { "info": { "name": "Top-N raw page_metrics rows across all browser monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/stats/sessions", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the top-N raw page_metrics rows across all browser monitors in\nthe project, sorted by the chosen metric.\n\nEach row carries its originating `monitor_id` so callers can attribute\nsessions back to the monitor that produced them." } ] }, { "info": { "name": "Browser Monitors", "type": "folder" }, "items": [ { "info": { "name": "List all Browser Monitors for a project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/browser/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all Browser Monitors for a project" }, { "info": { "name": "Create a new Browser Monitor", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/browser/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new Browser Monitor" }, { "info": { "name": "Read a Browser Monitor by ID", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read a Browser Monitor by ID" }, { "info": { "name": "Update an existing Browser Monitor", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing Browser Monitor" }, { "info": { "name": "Delete an existing Browser Monitor", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/monitors/browser/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing Browser Monitor" } ] }, { "info": { "name": "Calls", "type": "folder" }, "items": [ { "info": { "name": "Update-Kms-Helper", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/calls/:call_id/update-kms-helper", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new KMS helper API call based on an existing old helper API call." }, { "info": { "name": "List-Calls", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "api_url", "value": "", "type": "query" }, { "name": "domain", "value": "", "type": "query" }, { "name": "organization", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List API calls for the authenticated project." }, { "info": { "name": "Create-Call", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/calls/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new API call." }, { "info": { "name": "Build-Call-From-Curl", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/calls/build/curl", "body": { "type": "json", "data": "{}" } }, "docs": "Parse a curl command into an (unsaved) API call representation." }, { "info": { "name": "List-Calls-By-Auth", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/auth/:sc_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "sc_key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List API calls that use a given auth (ServiceConfig)." }, { "info": { "name": "Get-Call", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single API call by id." }, { "info": { "name": "Update-Call", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/calls/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update an API call (only supplied fields change)." }, { "info": { "name": "Delete-Call", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/calls/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an API call and return its last representation." }, { "info": { "name": "Run-Call-V2", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/calls/:call_id/run", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Trigger an on-demand run of an API call.\n\nDeprecated: use ``POST /api/3/monitors/{id}/run``." }, { "info": { "name": "Get-Call-Variables-Used", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/variables/used", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List variable names referenced by a monitor's request.\n\nScans the target url plus, where present, an API call's\nparameters/headers/body and an MCP monitor's step tool names and\narguments. Works for api, browser and mcp monitors." }, { "info": { "name": "Get-Call-Variables-Set", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/variables/set", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List variable names set by a monitor's post-test conditions.\n\nWorks for api, browser and mcp monitors." }, { "info": { "name": "Get-Call-Conditions", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/conditions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the post-test conditions for an API call." }, { "info": { "name": "Set-Call-Conditions", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/calls/:call_id/conditions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace the post-test conditions for an API call." } ] }, { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "List-Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/certificates/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List metadata for all of an org's Certificates." }, { "info": { "name": "Create-Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/certificates/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new Certificate." }, { "info": { "name": "Read-Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read an existing Certificate." }, { "info": { "name": "Update-Certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing Certificate." }, { "info": { "name": "Delete-Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/certificates/:certificate_id", "params": [ { "name": "certificate_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing Certificate." } ] }, { "info": { "name": "External Sources", "type": "folder" }, "items": [ { "info": { "name": "Ingest-External-Source", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/external/ingest/:source", "params": [ { "name": "source", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Ingest-External-Source" } ] }, { "info": { "name": "Files", "type": "folder" }, "items": [ { "info": { "name": "Upload-New-Oas", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/files/oas", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a new OpenAPI spec." }, { "info": { "name": "Upload-New-Oas-From-Url", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/files/oas_url", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a new OpenAPI spec." }, { "info": { "name": "List-Files", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/files/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List file uploads for the project, ordered by filename ascending." }, { "info": { "name": "Create-File", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/files/file", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a file from the raw request body, storing it in GCS." }, { "info": { "name": "Upload-File-From-Url", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/files/url", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download a remote URL and store the content as a file in GCS." }, { "info": { "name": "Get-File-Content", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/files/:key_str/content", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Serve the raw GCS content of a file." }, { "info": { "name": "Get-File", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/files/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the metadata representation of a single file." }, { "info": { "name": "Update-File", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/files/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partial-merge update of file metadata.\n\nA body that parses to an empty/falsy JSON value (``{}``) with a ``url:`` tag\non the entity is a signal to re-download the file from that URL (updating the\nGCS content and mimetype)." }, { "info": { "name": "Delete-File", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/files/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a file (GCS blob is NOT deleted — preserving legacy behaviour)." }, { "info": { "name": "Replace-File-Content", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/files/:key_str/file", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace the GCS content of an existing file." } ] }, { "info": { "name": "Governance", "type": "folder" }, "items": [ { "info": { "name": "List-Changes", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/changes", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "from_timestamp", "value": "", "type": "query" }, { "name": "to_timestamp", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return a list of changes within the given time range." }, { "info": { "name": "Get-Endpoint-Classifications", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/conformance/:spec/endpoints", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "spec", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Manage the classification of endpoints for a given spec" }, { "info": { "name": "Manage-Endpoint-Classification", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/governance/conformance/:spec/endpoints", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "spec", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Manage the classification of endpoints for a given spec" }, { "info": { "name": "Conformance-Results", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/conformance/results", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "resolved", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Query the conformance results" }, { "info": { "name": "List-Data-Checks", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/conformance/data-checks", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List data checks for the given project" }, { "info": { "name": "Put-Data-Check", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/governance/conformance/data-checks/:check_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "check_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create or update data check with the given name" }, { "info": { "name": "Delete-Data-Check", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/governance/conformance/data-checks/:check_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "check_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete data check with the given name" }, { "info": { "name": "Conformance-Results-Summary", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/conformance/results/summary", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Query the latest conformance result summary for a project" }, { "info": { "name": "Update-Resolution", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/governance/conformance/resolution", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the resolution status for a conformance result" }, { "info": { "name": "Evaluate-Most-Recent", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/governance/conformance/results/evaluate", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Run conformance checks and summary calculation on the most recent calls" }, { "info": { "name": "List-Settings", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/governance/conformance/settings", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve the conformance settings for a project" }, { "info": { "name": "Put-Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/governance/conformance/settings", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Insert or update conformance settings for a project" } ] }, { "info": { "name": "Integrations", "type": "folder" }, "items": [ { "info": { "name": "List-Integrations-For-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/integrations/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List-Integrations-For-Org" }, { "info": { "name": "Create-Integration", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/integrations/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create-Integration" }, { "info": { "name": "Get-Integration-By-Id", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get-Integration-By-Id" }, { "info": { "name": "Update-Integration", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update-Integration" }, { "info": { "name": "Delete-Integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete-Integration" }, { "info": { "name": "Authenticate-Datadog-Integration", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/integrations/datadog/authenticate", "params": [ { "name": "code", "value": "", "type": "query" }, { "name": "code_verifier", "value": "", "type": "query" }, { "name": "domain", "value": "", "type": "query" }, { "name": "redirect_uri", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Authenticate-Datadog-Integration" } ] }, { "info": { "name": "Inventory", "type": "folder" }, "items": [ { "info": { "name": "List-Inventory", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/inventory", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "from_timestamp", "value": "", "type": "query" }, { "name": "to_timestamp", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return a list of discovered endpoints." }, { "info": { "name": "Oas-Coverage", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/inventory/coverage", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "from_timestamp", "value": "", "type": "query" }, { "name": "to_timestamp", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return API call coverage data for OpenAPI endpoints." }, { "info": { "name": "Oas-Endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/inventory/endpoints/:file_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "file_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return a list of endpoints for the requested OpenAPI spec." } ] }, { "info": { "name": "MCP Monitor Statistics", "type": "folder" }, "items": [ { "info": { "name": "Aggregate performance metrics for an MCP monitor over a window", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/mcp/:monitor_id/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics for an MCP monitor over a window.\n\nReturns the requested measures (e.g. mean, p50, p90) per metric, optionally\ngrouped by location and/or time bucket." }, { "info": { "name": "Aggregate performance metrics across all MCP monitors in the project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/mcp/stats/performance", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregate performance metrics across all MCP monitors in the project.\n\nPair with `group_by=monitor` to get one PerformanceGroup per monitor; with\n`group_by=monitor,interval` for per-monitor time-series. Without a `monitor`\ngrouping, results are a single project-wide aggregate." } ] }, { "info": { "name": "MCP Monitors", "type": "folder" }, "items": [ { "info": { "name": "List all MCP Monitors for a project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/mcp/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all MCP Monitors for a project" }, { "info": { "name": "Create a new MCP Monitor", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/mcp/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new MCP Monitor" }, { "info": { "name": "Read an MCP Monitor by ID", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/mcp/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read an MCP Monitor by ID" }, { "info": { "name": "Update an existing MCP Monitor", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/monitors/mcp/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing MCP Monitor" }, { "info": { "name": "Patch an existing MCP Monitor", "type": "http" }, "http": { "method": "PATCH", "url": "https://client.apimetrics.io/api/3/monitors/mcp/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Patch an existing MCP Monitor" }, { "info": { "name": "Delete an existing MCP Monitor", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/monitors/mcp/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing MCP Monitor" } ] }, { "info": { "name": "Monitors", "type": "folder" }, "items": [ { "info": { "name": "List all Monitors for a project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all Monitors for a project" }, { "info": { "name": "Read a Monitor by ID", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/monitors/:monitor_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read a Monitor by ID" }, { "info": { "name": "Trigger a Monitor to run now", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/monitors/:monitor_id/run", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "monitor_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Trigger a Monitor to run now" } ] }, { "info": { "name": "Downtimes", "type": "folder" }, "items": [ { "info": { "name": "List-Org-Downtimes", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/downtimes", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List downtimes defined on the given org." }, { "info": { "name": "Create-Org-Downtime", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/downtimes", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new downtime for this org." }, { "info": { "name": "Update-Org-Downtime", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/downtimes/:downtime_id", "params": [ { "name": "downtime_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing downtime for this org." }, { "info": { "name": "Delete-Org-Downtime", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/downtimes/:downtime_id", "params": [ { "name": "downtime_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing downtime for this org." } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "List-Security-Profiles-For-Project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/project/security-profiles", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List-Security-Profiles-For-Project" }, { "info": { "name": "List-Agents-For-Project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/project/agents", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all agents accessible to a project.\nReturns the project's agent list (its organization's ``agents:``\nsystem tag, or the public list) plus agents owned by the project's\norganization or by the project itself.\nPersonal projects (no org) only get public and project-owned agents." }, { "info": { "name": "List-Projects-In-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/projects/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "include_quota", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "system_tag", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List projects in an organization." }, { "info": { "name": "Create-Project-In-Org", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/projects/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new project in an organization." }, { "info": { "name": "Delete-Project-From-Org", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/projects/:project_key_str/", "params": [ { "name": "project_key_str", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a project from an organization (re-homes it to community)." }, { "info": { "name": "Get-Project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a project by key." }, { "info": { "name": "Update-Project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a project's name, tags, email, or security profile." } ] }, { "info": { "name": "Remote Agents", "type": "folder" }, "items": [ { "info": { "name": " List Agents", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/agents/", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " List Agents" }, { "info": { "name": " Create Agent", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/agents/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " Create Agent" }, { "info": { "name": " Agent By Id", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/agents/:agent_id", "params": [ { "name": "agent_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " Agent By Id" }, { "info": { "name": " Update Agent", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/agents/:agent_id", "params": [ { "name": "agent_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " Update Agent" }, { "info": { "name": " Delete Agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/agents/:agent_id", "params": [ { "name": "agent_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " Delete Agent" }, { "info": { "name": " Agent Config By Id", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/agents/:agent_id/config", "params": [ { "name": "agent_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": " Agent Config By Id" } ] }, { "info": { "name": "Results", "type": "folder" }, "items": [ { "info": { "name": "Get-Result-Content", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/results/:result_id/content/:path", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_id", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get-Result-Content" }, { "info": { "name": "Get-Result-Screenshot", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/results/:result_id/screenshot", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get-Result-Screenshot" }, { "info": { "name": "List-Results", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "result_category", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a project." }, { "info": { "name": "List-Results-By-Call", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/call/:test_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "result_category", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a specific API call." }, { "info": { "name": "List-Results-By-Hook", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/hook/:hook_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "hook_key_str", "value": "", "type": "path" }, { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "result_category", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a specific webhook." }, { "info": { "name": "Get-Result", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/:result_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_key_str", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "query" }, { "name": "header_style", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single result.\n\n``mode=full`` adds the messages, log messages, cert info and the request\nbody; ``header_style=mapping`` renders headers as a name -> value mapping.\nA below-ANALYST caller gets the summary only -- no request, response or\ncontext." }, { "info": { "name": "Get-Result-Content", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/:result_key_str/content", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download the raw response body for a result." }, { "info": { "name": "Get-Result-Pcap", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/results/:result_key_str/pcap", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "PCAP download is not available in this environment." }, { "info": { "name": "List-Results-By-Call-Alias", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/results", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "result_category", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a specific API call (alias path)." }, { "info": { "name": "List-Results-By-Hook-Alias", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/hooks/:hook_key_str/results", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "hook_key_str", "value": "", "type": "path" }, { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "result_category", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a specific webhook (alias path)." } ] }, { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "List-Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/schedules/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List schedules for the project." }, { "info": { "name": "Create-Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/schedules/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new schedule for the project." }, { "info": { "name": "Get-Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/schedules/:schedule_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific schedule by ID." }, { "info": { "name": "Update-Schedule", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/schedules/:schedule_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing schedule." }, { "info": { "name": "Delete-Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/schedules/:schedule_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing schedule for this org." }, { "info": { "name": "Add-Call-To-Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/schedules/:schedule_id/targets/:target_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add a target to an existing schedule." }, { "info": { "name": "Remove-Call-From-Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/schedules/:schedule_id/targets/:target_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "target_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a target from an existing schedule." }, { "info": { "name": "List-Schedules-By-Call", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/call/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List schedules that target a specific API call." }, { "info": { "name": "List-Schedules-By-Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/workflow/:workflow_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List schedules that target a specific workflow." }, { "info": { "name": "List-Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all schedules for the authenticated project.\n\nA project with no schedules and no cursor gets a freshly-created\n\"Default Schedule\".\n\nDeprecated: use ``GET /api/3/schedules/`` instead." }, { "info": { "name": "Create-Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new schedule.\n\nDeprecated: use ``POST /api/3/schedules/`` instead." }, { "info": { "name": "Get-Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single schedule by id.\n\nDeprecated: use ``GET /api/3/schedules/{schedule_id}`` instead." }, { "info": { "name": "Update-Schedule", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a schedule (only supplied fields change).\n\nDeprecated: use ``PUT /api/3/schedules/{schedule_id}`` instead." }, { "info": { "name": "Delete-Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a schedule and return its last representation.\n\nDeprecated: use ``DELETE /api/3/schedules/{schedule_id}`` instead." }, { "info": { "name": "Ensure-Schedule-Call", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/call/:call_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Associate an API call with a schedule (idempotent; 202 if already associated).\n\nDeprecated: use ``POST /api/3/schedules/{schedule_id}/targets/{target_id}``\ninstead." }, { "info": { "name": "Remove-Schedule-Call", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/call/:call_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Disassociate an API call from a schedule (202 if it was not associated).\n\nDeprecated: use ``DELETE /api/3/schedules/{schedule_id}/targets/{target_id}``\ninstead." }, { "info": { "name": "Ensure-Schedule-Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/run/:workflow_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Associate a workflow with a schedule (idempotent; 202 if already associated).\n\nDeprecated: use ``POST /api/3/schedules/{schedule_id}/targets/{target_id}``\ninstead -- it accepts both call and workflow target ids." }, { "info": { "name": "Remove-Schedule-Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/run/:workflow_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Disassociate a workflow from a schedule (202 if it was not associated).\n\nDeprecated: use ``DELETE /api/3/schedules/{schedule_id}/targets/{target_id}``\ninstead -- it accepts both call and workflow target ids." }, { "info": { "name": "List-Schedule-Downtimes", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/downtime/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List scheduled downtimes for a schedule." }, { "info": { "name": "Create-Schedule-Downtime", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/:schedule_id/downtime/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a scheduled downtime under a schedule." }, { "info": { "name": "Get-Schedule-Downtime", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/schedules/downtime/:downtime_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "downtime_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single scheduled downtime by id." }, { "info": { "name": "Update-Schedule-Downtime", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/schedules/downtime/:downtime_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "downtime_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a scheduled downtime (only supplied fields change)." }, { "info": { "name": "Delete-Schedule-Downtime", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/schedules/downtime/:downtime_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "downtime_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a scheduled downtime and return its last representation." } ] }, { "info": { "name": "Service Accounts", "type": "folder" }, "items": [ { "info": { "name": "List-Service-Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List the service accounts defined on the given organization." }, { "info": { "name": "Create-Service-Account", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a service account. The client_secret is returned once, here only." }, { "info": { "name": "Get-Service-Account", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single service account. The client_secret is never returned." }, { "info": { "name": "Delete-Service-Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a service account and its Auth0 client and virtual user." }, { "info": { "name": "Update-Service-Account-Roles", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id/roles", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace the organization roles granted to a service account." }, { "info": { "name": "Rotate-Service-Account-Secret", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id/rotate_secret", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Rotate the client secret. The new secret is returned once, here only." }, { "info": { "name": "Grant-Service-Account-Project-Access", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id/projects/:project_id", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Grant a service account a project access level (VIEWER/EDITOR/etc.)." }, { "info": { "name": "Revoke-Service-Account-Project-Access", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/organizations/:org_id/service_accounts/:service_account_id/projects/:project_id", "params": [ { "name": "service_account_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Revoke a service account's access to a project." } ] }, { "info": { "name": "Suppliers", "type": "folder" }, "items": [ { "info": { "name": "List-Suppliers", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/suppliers" }, "docs": "Return a categorised list of suppliers." }, { "info": { "name": "Get-Project-Suppliers", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/project/suppliers", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the list of enabled suppliers for the selected project." }, { "info": { "name": "Put-Project-Suppliers", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/project/suppliers", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set the list of enabled suppliers for the selected project" }, { "info": { "name": "Get-Suppliers-Results", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/project/suppliers/results", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Query the current supplier results for the selected project" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List-Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "monitor_id", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List webhooks for the project." }, { "info": { "name": "Create-Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new webhook for the project." }, { "info": { "name": "Get-Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/webhooks/:webhook_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a specific webhook by ID." }, { "info": { "name": "Update-Webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/3/webhooks/:webhook_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing webhook." }, { "info": { "name": "Delete-Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/3/webhooks/:webhook_id", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "webhook_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing webhook for this project." }, { "info": { "name": "List-Webhook-Types-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/webhooks/types", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every supported webhook service type." }, { "info": { "name": "Get-Webhook-Type-Properties-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/webhooks/types/:type", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List the parameter descriptors for a webhook service type." }, { "info": { "name": "List-Webhooks-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List project-level webhooks." }, { "info": { "name": "Create-Webhook-V2", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a project-level webhook." }, { "info": { "name": "Snooze-Webhook-V2", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/webhooks/snooze/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "web_hook_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Snooze (partially update) a webhook." }, { "info": { "name": "Get-Webhook-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "web_hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a project-level webhook." }, { "info": { "name": "Update-Webhook-V2", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "web_hook_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a project-level webhook." }, { "info": { "name": "Delete-Webhook-V2", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "web_hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a project-level webhook, returning the deleted representation." }, { "info": { "name": "List-Call-Webhooks-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List webhooks bound to a specific API call." }, { "info": { "name": "Create-Call-Webhook-V2", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/webhooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a webhook bound to a specific API call." }, { "info": { "name": "Get-Call-Webhook-V2", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "web_hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a webhook bound to a specific API call." }, { "info": { "name": "Update-Call-Webhook-V2", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "web_hook_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a webhook bound to a specific API call." }, { "info": { "name": "Delete-Call-Webhook-V2", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/calls/:test_key_str/webhooks/:web_hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "web_hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a webhook bound to a specific API call, returning the deleted representation." } ] }, { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "Get-Workflow-Locations", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/3/workflows/:workflow_id/locations", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get-Workflow-Locations" }, { "info": { "name": "Run-Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/3/workflows/:workflow_id/run", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Run-Workflow" }, { "info": { "name": "List-Workflows-By-Call", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/workflows/call/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List workflows that reference a specific API call." }, { "info": { "name": "List-Workflows", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/workflows/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all workflows for the authenticated project." }, { "info": { "name": "Create-Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/workflows/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new workflow." }, { "info": { "name": "Get-Workflow-Result", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/workflows/results/:result_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single workflow result." }, { "info": { "name": "List-Workflow-Results-By-Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/workflows/:workflow_id/results/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" }, { "name": "time", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List results for a workflow within the ``?from``/``?time`` date window." }, { "info": { "name": "Get-Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/workflows/:workflow_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single workflow by id." }, { "info": { "name": "Update-Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/workflows/:workflow_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a workflow (only supplied fields change)." }, { "info": { "name": "Delete-Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/workflows/:workflow_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a workflow and return its last representation." }, { "info": { "name": "Run-Workflow-V2", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/workflows/:workflow_key_str/run", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workflow_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Trigger an on-demand run of a workflow." } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Get-Account", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the caller's Auth0 profile fields." }, { "info": { "name": "Update-Account-Put", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/account/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the caller's Auth0 profile via the Management API." }, { "info": { "name": "Get-Account-Billing", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/billing", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Billing summary for every org/project the caller can bill for." }, { "info": { "name": "Get-Account-Quota", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/quota", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "clear_cache", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Quota and current usage for the caller's active project." }, { "info": { "name": "Verify-Account-Email", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/verify", "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "(Re)send the caller's email-verification message if not yet verified." }, { "info": { "name": "Reset-Account-Password", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/reset_password", "headers": [ { "name": "Apimetrics-Project-Id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Send a password-reset email (own address, or another if authorised)." }, { "info": { "name": "List-Account-Projects", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/projects", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List the projects and organizations the caller can access.\n\nReturns the ``{meta, projects, organizations}`` envelope: ``meta`` carries\nthe caller's account id, org roles, and permissions; ``projects`` lists each\nreachable project (direct grants and org-role grants merged, highest access\nkept); ``organizations`` maps each relevant org id to its details.\n\nThe project the frontend is currently viewing (the stateless replacement for\nthe legacy session value) lets a site-level caller see that project" }, { "info": { "name": "Create-Account-Project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/projects", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new personal project owned by the caller." }, { "info": { "name": "Get subscription for a project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/subscription/proj/:sub_id", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get subscription for a project" }, { "info": { "name": "Update subscription for a project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/subscription/proj/:sub_id", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update subscription for a project" }, { "info": { "name": "Get usage statistics for a project subscription", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/subscription/proj/:sub_id/usage", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get usage statistics for a project subscription" }, { "info": { "name": "Get subscription for an organisation", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/subscription/org/:sub_id", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get subscription for an organisation" }, { "info": { "name": "Update subscription for an organisation", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/subscription/org/:sub_id", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update subscription for an organisation" }, { "info": { "name": "Get usage statistics for an organisation subscription", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/subscription/org/:sub_id/usage", "params": [ { "name": "sub_id", "value": "", "type": "path", "description": "Project or organisation subscription ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get usage statistics for an organisation subscription" } ] }, { "info": { "name": "Account Settings", "type": "folder" }, "items": [ { "info": { "name": "List-Account-Setting-Catalogs", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account-settings/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every enabled settings catalog available on the platform.\n\nReturns each catalog's public metadata (``id``, ``title``,\n``description``, ``enabled``). The set of catalogs is defined by\nthe server and is the same for every caller." }, { "info": { "name": "Get-Account-Setting-Catalog", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account-settings/:catalog_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "catalog_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every variable in the named catalog for the active project.\n\nEach variable carries a ``value`` field showing either the project's\noverride or the platform default. An unknown catalog name yields an\nempty ``results`` list rather than 404 (matches the legacy contract)." }, { "info": { "name": "Reset-Account-Setting-Catalog", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/account-settings/:catalog_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "catalog_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Reset every variable in the catalog back to the platform default.\n\nDeletes the catalog entity and every persisted override underneath\nit. Idempotent: returns ``{\"status\": \"OK\"}`` whether or not\nanything was stored." }, { "info": { "name": "Get-Account-Setting-Variable", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account-settings/:catalog_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "catalog_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read a single variable's static config plus its current value.\n\nReturns 404 if the variable name isn't defined in the catalog's\nconfiguration." }, { "info": { "name": "Set-Account-Setting-Variable", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account-settings/:catalog_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "catalog_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Override the variable's value for this project.\n\nThe submitted value is coerced to the variable's declared type\n(integer, string, or boolean) and validated against any configured\nrange / length / choice constraints. Invalid values or unknown\nvariable names return 400. Returns the persisted entity on success." }, { "info": { "name": "Delete-Account-Setting-Variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/account-settings/:catalog_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "catalog_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove the project's override for this variable.\n\nAfter deletion the variable reverts to the platform default value.\nIdempotent: returns ``{\"status\": \"OK\"}`` whether or not an override\nexisted." } ] }, { "info": { "name": "Agents", "type": "folder" }, "items": [ { "info": { "name": "List-Agents", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/agents/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "organization", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List remote agents available to the caller.\n\nAgents are shared infrastructure -- callers see any agent whose\n``owners`` list contains ``\"public\"``, the caller's project id, or\n(with ``organization``) the caller's org id. Non-paginated: up to\n200 rows returned in a single response." }, { "info": { "name": "Agents-Info", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/agents/info", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return grouped agent metadata used to populate location pickers.\n\nThe response contains a ``regions`` list (region id + display name +\nthe location IDs in that region), a ``locations`` map (agent name to\nhuman-readable label), an ``agent_list``, and an empty\n``postman_locations`` (kept for response-shape stability).\nReachable anonymously -- no auth headers required. An anonymous\ncaller sees public agents; an authenticated caller additionally sees\nagents owned by their orgs or project." }, { "info": { "name": "Get-Agent", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/agents/:agent_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "agent_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Read a single agent by key.\n\nRequires the caller to own the agent -- either as a site admin, or\nbecause their project key is listed in the agent's ``owners``. A\nplain project API key has no such ownership on shared agents, so\n``get`` and ``update`` by key are reserved for administrators.\nReturns 404 for unknown agents and for agents the caller can't own." }, { "info": { "name": "Update-Agent", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/agents/:agent_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "agent_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the display metadata (name, cloud, geography, ...) of an agent.\n\nSame ownership rules as ``get-agent``: reserved for administrators.\nOnly fields the caller supplies are updated; omitted fields keep\ntheir existing values." }, { "info": { "name": "Get a remote agent", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/agents/:agent_key/", "params": [ { "name": "agent_key", "value": "", "type": "path", "description": "URL-safe Datastore key for a remote agent" } ] }, "docs": "Get a remote agent" }, { "info": { "name": "Update a remote agent", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/agents/:agent_key/", "params": [ { "name": "agent_key", "value": "", "type": "path", "description": "URL-safe Datastore key for a remote agent" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a remote agent" }, { "info": { "name": "Delete a remote agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/agents/:agent_key/", "params": [ { "name": "agent_key", "value": "", "type": "path", "description": "URL-safe Datastore key for a remote agent" } ] }, "docs": "Delete a remote agent" } ] }, { "info": { "name": "API Keys", "type": "folder" }, "items": [ { "info": { "name": "List-Api-Keys", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/api_keys/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every API key bound to the caller's project (including the caller's\nown key)." }, { "info": { "name": "Create-Api-Key", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/api_keys/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Mint a new API key for the caller's project. The freshly generated secret\nis returned in ``api_key`` on this response only." }, { "info": { "name": "Delete-Api-Key", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/api_keys/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an API key by its urlsafe id and echo the deleted key body." } ] }, { "info": { "name": "Audits", "type": "folder" }, "items": [ { "info": { "name": "List-Audits", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/audits/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List audit records for the project." }, { "info": { "name": "List-Audits-By-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/audits/organization/:org_id/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List audit records for an organization." }, { "info": { "name": "List-Audits-By-Resource", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/audits/resource/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "include", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List audit records for a specific resource, optionally merging related kinds.\n\nA resource's history is not owned by the active project -- org-level entities\nrecord their org as the owning scope -- so this route authorizes by scope\nrather than gating on project access alone: EDITOR on the header project and\nADMIN on an org (which reaches the org's own records *and* its projects') are\nindependent bases for the read (see ``_audit_scope_readable``). Callers with\nneither get 403." } ] }, { "info": { "name": "Auth Settings", "type": "folder" }, "items": [ { "info": { "name": "List-Auth-Settings", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/auth/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List auth configs for the project." }, { "info": { "name": "Create-Auth-Setting", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/auth/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an auth config for the project." }, { "info": { "name": "List-Auth-Settings-By-Domain", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/auth/domain/:domain/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List auth configs for the project filtered by domain." }, { "info": { "name": "Get-Auth-Setting", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/auth/:sc_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "sc_key", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single auth config." }, { "info": { "name": "Update-Auth-Setting", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/auth/:sc_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "sc_key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an auth config." }, { "info": { "name": "Delete-Auth-Setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/auth/:sc_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "sc_key", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an auth config." } ] }, { "info": { "name": "Auth Tokens", "type": "folder" }, "items": [ { "info": { "name": "List-Auth-Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/tokens/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List auth tokens for the project, ordered by name." }, { "info": { "name": "Create-Auth-Token", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/tokens/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an auth token bound to an auth setting." }, { "info": { "name": "List-Auth-Tokens-By-Auth-Setting", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/tokens/auth/:sc_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "sc_key", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List auth tokens belonging to a single auth setting." }, { "info": { "name": "Get-Auth-Token", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/tokens/:token_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "token_key", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single auth token." }, { "info": { "name": "Update-Auth-Token", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/tokens/:token_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "token_key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update an auth token." }, { "info": { "name": "Delete-Auth-Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/tokens/:token_key/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "token_key", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an auth token, returning the deleted representation." } ] }, { "info": { "name": "Stats", "type": "folder" }, "items": [ { "info": { "name": "Get-Call-Stats", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period." }, { "name": "type", "value": "", "type": "query", "description": "Result-code filter; `ALL` counts every result." }, { "name": "metric", "value": "", "type": "query", "description": "Latency metric to aggregate." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Aggregated performance stats for a single period." }, { "info": { "name": "Get-Call-Stats-Since", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/since", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period (`RAW` for per-result rows)." }, { "name": "type", "value": "", "type": "query", "description": "Result-code filter; `ALL` counts every result." }, { "name": "metric", "value": "", "type": "query", "description": "Latency metric to aggregate." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of rows to return (default 1000 aggregated, 5000 for RAW)." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Performance buckets from a start time forwards." }, { "info": { "name": "Get-Call-Stats-Before", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/before", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period (`RAW` for per-result rows)." }, { "name": "type", "value": "", "type": "query", "description": "Result-code filter; `ALL` counts every result." }, { "name": "metric", "value": "", "type": "query", "description": "Latency metric to aggregate." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of rows to return (default 1000 aggregated, 5000 for RAW)." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Performance buckets up to an end time." }, { "info": { "name": "Get-Call-Http-Codes", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/http_codes", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "HTTP status-code breakdown for a single period." }, { "info": { "name": "Get-Call-Failures", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/failures", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: use the breakdown endpoint instead." }, { "info": { "name": "Get-Call-Passfail", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/passfail", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." }, { "name": "format", "value": "", "type": "query", "description": "Any non-empty value returns the raw combined stats map instead of the reshaped pass/warning/failure counts." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pass/warning/failure counts for a single period." }, { "info": { "name": "Get-Call-Passfail-Total", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/passfail_total", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Overall pass/fail totals over the call's most recent hour range." }, { "info": { "name": "Get-Call-Passfail-Range", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/passfail_range", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Grouping period." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pass/fail counts grouped by period over a range." }, { "info": { "name": "Get-Call-Legacy-Passfail", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/legacy/passfail", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pass/fail counts for a single period (legacy synopsis endpoint)." }, { "info": { "name": "Get-Call-Legacy-Passfail-Range", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/legacy/passfail_range", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Grouping period." }, { "name": "location_id", "value": "", "type": "query", "description": "Agent location id to filter to, or `__ALL__` for all locations." }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Pass/fail counts grouped by period (legacy synopsis endpoint)." }, { "info": { "name": "Get-Call-Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/calls/:call_id/stats/metrics/:location_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "location_id", "value": "", "type": "path", "description": "Agent location id, or `__ALL__` for all locations." }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period." }, { "name": "quantile", "value": "", "type": "query", "description": "Percentile to compute (0–100)." }, { "name": "metric", "value": "", "type": "query", "description": "Latency metric to aggregate." }, { "name": "metric[]", "value": "", "type": "query", "description": "Repeatable; one output column per metric. Overrides `metric`." }, { "name": "category", "value": "", "type": "query", "description": "Restrict the quantile to a single result category." }, { "name": "dest_ip", "value": "", "type": "query", "description": "Group results by destination IP as well as domain/location when truthy (`1`/`t`/`true`)." }, { "name": "time", "value": "", "type": "query", "description": "Point in time selecting the period to report (ISO 8601, UTC assumed if no offset). Defaults to now." }, { "name": "start", "value": "", "type": "query", "description": "Start of the reporting window (ISO 8601). Clamped to the call's creation time." }, { "name": "end", "value": "", "type": "query", "description": "End of the reporting window (ISO 8601). Clamped to now." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Quantile statistics for one or more metrics, grouped by domain." } ] }, { "info": { "name": "Crypto Utilities", "type": "folder" }, "items": [ { "info": { "name": "Decode-Jwt", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/jwt/decode" }, "docs": "Decode a JWT (without verifying its signature).\n\nThe JWT is read from the raw request body. Returns its header, payload and\nsignature segment. If the payload cannot be decoded, ``error`` replaces\n``payload``." }, { "info": { "name": "Encode-Jwt", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/jwt/encode", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Sign a JWT from the supplied claims, headers and key.\n\nBy default the raw token is returned with ``Content-Type: application/jwt``.\nPass ``output: \"json\"`` to receive a structured breakdown of the token\ninstead. Authentication is optional and only used to resolve a KMS signing\ncertificate when the header carries a ``kid`` for a KMS-enabled org." }, { "info": { "name": "Hmac-Hash", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/hash/hmac", "body": { "type": "json", "data": "{}" } }, "docs": "Compute an HMAC digest of a message under a key and hash algorithm." }, { "info": { "name": "Rsa-Sign", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/sign/rsa", "body": { "type": "json", "data": "{}" } }, "docs": "Produce an RSA signature of a message using a PEM private key." } ] }, { "info": { "name": "Session", "type": "folder" }, "items": [ { "info": { "name": "Logout", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/logout" }, "docs": "Clear the legacy session cookie. Always returns ``\"OK\"``." } ] }, { "info": { "name": "Conditions", "type": "folder" }, "items": [ { "info": { "name": "Get-Project-Conditions", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/conditions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the project-default post-test conditions.\n\nAn untouched project returns the built-in default conditionals rather than an\nempty list." }, { "info": { "name": "Set-Project-Conditions", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/conditions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace the project-default post-test conditions." } ] }, { "info": { "name": "Environment", "type": "folder" }, "items": [ { "info": { "name": "List-Environment-Workspaces", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/environment/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List environment workspaces for the authenticated project." }, { "info": { "name": "Create-Environment-Workspace", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/environment/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an environment workspace (idempotent-by-name)." }, { "info": { "name": "List-Environment-Variables", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List variables in an environment workspace." }, { "info": { "name": "Update-Environment-Workspace-Title", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an environment workspace's title." }, { "info": { "name": "Create-Environment-Variable", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create (or overwrite by name) a variable in a workspace.\n\nAuto-creates the workspace if it does not already exist." }, { "info": { "name": "Delete-Environment-Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an empty, unreferenced environment workspace." }, { "info": { "name": "Get-Environment-Variable", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single variable by name." }, { "info": { "name": "Update-Environment-Variable", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a variable's value." }, { "info": { "name": "Delete-Environment-Variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/environment/:workspace_name/:variable_name", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "workspace_name", "value": "", "type": "path" }, { "name": "variable_name", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a variable (idempotent)." } ] }, { "info": { "name": "Export", "type": "folder" }, "items": [ { "info": { "name": "Export-Project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/export/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "webhooks", "value": "", "type": "query" }, { "name": "environment_values", "value": "", "type": "query" }, { "name": "header_values", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Export the caller's project configuration as an import bundle." }, { "info": { "name": "Tag-Project-Entities", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/export/tag", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Assign ``importer:`` tags to any project entities that lack one." } ] }, { "info": { "name": "Import", "type": "folder" }, "items": [ { "info": { "name": "Import-Project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/import/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Import a configuration bundle into the caller's project.\n\nThe body is parsed as JSON or YAML per ``Content-Type``, validated against\nthe import schema, then applied. The (mutated) bundle is echoed back with a\n200 — imported object ids are rewritten to the created datastore keys." }, { "info": { "name": "Import-Sample-Projects", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/import/sample", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Clone one or more sample-org projects into the caller's project." } ] }, { "info": { "name": "Hooks", "type": "folder" }, "items": [ { "info": { "name": "List-Hooks", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/hooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List hooks for the project, newest first." }, { "info": { "name": "Create-Hook", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/hooks/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a hook bound to a workflow target." }, { "info": { "name": "Get-Hook", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/hooks/:hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a hook." }, { "info": { "name": "Update-Hook", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/hooks/:hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "hook_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a hook." }, { "info": { "name": "Delete-Hook", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/hooks/:hook_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "hook_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a hook, returning the deleted representation." } ] }, { "info": { "name": "Insights", "type": "folder" }, "items": [ { "info": { "name": "List-Insights", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List pre-computed insights reports for the project." }, { "info": { "name": "List-Insights-Rank", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/rank/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "weekly", "value": "", "type": "query", "description": "Set true/t/1 for weekly instead of monthly." }, { "name": "reverse", "value": "", "type": "query", "description": "Set true/t/1 to sort best-first instead of worst-first." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Score-ranked most-recent reports plus a short score history per monitor." }, { "info": { "name": "List-Insights-Rank-History", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/rank/history", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Window start (YYYY-MM-DD). Defaults to ~6 months ago." }, { "name": "end_date", "value": "", "type": "query", "description": "Window end (YYYY-MM-DD). Defaults to ~now." }, { "name": "weekly", "value": "", "type": "query", "description": "Set true/t/1 for weekly instead of monthly." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "good/ok/bad score-band counts per period bucket across a date window." }, { "info": { "name": "Get-Call-Insights", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/call/:call_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "call_id", "value": "", "type": "path" }, { "name": "weekly", "value": "", "type": "query", "description": "Set true/t/1 for the latest weekly report." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Latest insights report for a single monitor (empty object if none)." }, { "info": { "name": "Get-Insights-Outliers", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/:filename/outliers", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Report key of the form ``{call_id}__{start_date}__{end_date}``." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download an outliers blob, rewriting numeric result ids to urlsafe keys." }, { "info": { "name": "Get-Insights", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/insights/:filename/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "filename", "value": "", "type": "path", "description": "Report key of the form ``{call_id}__{start_date}__{end_date}``." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download a pre-computed insights report blob from cloud storage." } ] }, { "info": { "name": "Manage", "type": "folder" }, "items": [ { "info": { "name": "Copy-Resources", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/manage/copy", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Clone resources from the active project into another project.\n\nCascades behaviour (see ``manage.copy_call`` etc.):\n * Calls: copies the underlying ServiceConfig + emits warnings that\n tokens and files are NOT cloned. Copies PostTestConditions and\n non-``apimetrics_*`` webhooks.\n * Workflows: also clones every referenced Call.\n * Auths / Reports: cloned in isolation.\n\nSet ``dry_run=true`` to preview without writing." }, { "info": { "name": "Move-Resources", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/manage/move", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Re-parent resources from the active project to another project.\n\nGuards (return 400 outside of dry-run, accumulate into ``errors[]``\nin dry-run):\n * Calls / workflows referenced by a Schedule cannot be moved.\n * Calls with a ``file_key`` cannot be moved.\n * Moving an auth shared by a not-being-moved call is blocked.\n * Moving where ``destination == source`` is rejected with 400.\n\nCross-org moves emit two Cloud Tasks to re-home ClickHouse + Insights\ndata for each call. See ``move_api_" } ] }, { "info": { "name": "Invites", "type": "folder" }, "items": [ { "info": { "name": "Accept-Invite", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/invite/:invite_key_str", "params": [ { "name": "invite_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Accept an org or project invite by urlsafe key (email must match caller)." }, { "info": { "name": "Reject-Invite", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/account/invite/:invite_key_str", "params": [ { "name": "invite_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete (reject) an invite; email must match the caller's account." }, { "info": { "name": "Verify-Invite-Secret", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/account/invite/:invite_id/:invite_secret/", "params": [ { "name": "invite_id", "value": "", "type": "path" }, { "name": "invite_secret", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Verify an invite link (invite_id + secret) and return the invite." }, { "info": { "name": "Accept-Invite-Secret", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/account/invite/:invite_id/:invite_secret/", "params": [ { "name": "invite_id", "value": "", "type": "path" }, { "name": "invite_secret", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Accept an invite by link (invite_id + secret)." }, { "info": { "name": "List-Org-Invites", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/invites/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List pending invites for the organisation, ordered by email." }, { "info": { "name": "Create-Org-Invite", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/invites/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an invite for an account to join the organisation; sends an email." }, { "info": { "name": "Delete-Org-Invite", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/invites/:invite_key_str/", "params": [ { "name": "invite_key_str", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a pending org invite. 404 if absent, 403 if org_id mismatch." }, { "info": { "name": "List-Project-Invites", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/invites/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List pending invites for the project, ordered by email." }, { "info": { "name": "Create-Project-Invite", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/invites/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an invite for an account to join the project; sends an email." }, { "info": { "name": "Delete-Project-Invite", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/invites/:invite_key_str/", "params": [ { "name": "invite_key_str", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a pending project invite. 404 if absent or from another project." } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "List-Notifications", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/notifications/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List notifications owned by the project, newest first." }, { "info": { "name": "List-Notifications-By-Call", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/notifications/call/:test_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "test_key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List notifications referencing a specific call, newest first." }, { "info": { "name": "Get-Notification", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/notifications/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Return the representation of a single notification." }, { "info": { "name": "Update-Notification", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/notifications/:key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the ``viewed`` flag for the requesting project. No other field is writable." } ] }, { "info": { "name": "Users (admin)", "type": "folder" }, "items": [ { "info": { "name": "Get-User-By-Username", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/users/username/:username/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a user by username. Full details for site/org admins; username only otherwise." }, { "info": { "name": "Get-User", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/users/:user_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "user_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a user by NDB key. Full details for site/org admins; username only otherwise." }, { "info": { "name": "Update-User", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/users/:user_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "user_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a user's admin flag. Requires org-admin or site-admin." }, { "info": { "name": "Delete-User", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/users/:user_key_str/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "user_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a user from their org, clearing admin flag and access on owned models." } ] }, { "info": { "name": "OpenAPI", "type": "folder" }, "items": [ { "info": { "name": "Tag-Project-For-Openapi", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/openapi/tag", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "strict_slash", "value": "", "type": "query" }, { "name": "file_id", "value": "", "type": "query" }, { "name": "force", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Tag-Project-For-Openapi" }, { "info": { "name": "Validate-Openapi", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/openapi/validate/:result_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "result_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Validate-Openapi" } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "List-Orgs", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "system_tag", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all organizations (site admin/analyst/viewer/quota_viewer only)." }, { "info": { "name": "Get-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "include_quota", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get an organization by ID." }, { "info": { "name": "Update-Org", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an organization's name, tags, or security settings." }, { "info": { "name": "List-Accounts-In-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/accounts/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List Auth0 accounts in an organization." }, { "info": { "name": "Get-Account-In-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/accounts/:account_id/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get an Auth0 account that is a member of the organization." }, { "info": { "name": "Delete-Account-From-Org", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/accounts/:account_id/", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove an account from an organization." } ] }, { "info": { "name": "Project Access", "type": "folder" }, "items": [ { "info": { "name": "List-Project-Access-By-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/projects/access", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all direct account access grants across an organization's projects." }, { "info": { "name": "List-Project-Access", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/access/", "params": [ { "name": "project_key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List direct account access grants for a project." }, { "info": { "name": "Create-Project-Access", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/access/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Grant an account direct access to a project." }, { "info": { "name": "Get-Project-Access", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/access/:project_access_id/", "params": [ { "name": "project_access_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a project access grant by id." }, { "info": { "name": "Update-Project-Access", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/access/:project_access_id/", "params": [ { "name": "project_access_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a project access grant." }, { "info": { "name": "Delete-Project-Access", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/access/:project_access_id/", "params": [ { "name": "project_access_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a project access grant." } ] }, { "info": { "name": "Organization Roles", "type": "folder" }, "items": [ { "info": { "name": "List-Org-Roles", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/roles/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all roles defined for an organization." }, { "info": { "name": "Create-Org-Role", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/roles/", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new role for an organization." }, { "info": { "name": "Delete-Org-Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/roles/:role_id/", "params": [ { "name": "role_id", "value": "", "type": "path" }, { "name": "org_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a role from an organization." }, { "info": { "name": "List-Project-Roles-By-Org", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/organizations/:org_id/roles/access", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all project roles across an organization's projects." } ] }, { "info": { "name": "Project Setup", "type": "folder" }, "items": [ { "info": { "name": "Get-Current-Project", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the current project." }, { "info": { "name": "Update-Current-Project", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/project/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the current project's name or tags." }, { "info": { "name": "Replace-Current-Project", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/project/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the current project's name or tags (alias of POST)." } ] }, { "info": { "name": "Project SLOs", "type": "folder" }, "items": [ { "info": { "name": "Get-Project-Slo", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project/slo/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the current project's SLO (defaults when none is stored)." }, { "info": { "name": "Update-Project-Slo", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/project/slo/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create or update the current project's SLO." }, { "info": { "name": "Delete-Project-Slo", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/project/slo/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete the current project's SLO (idempotent)." } ] }, { "info": { "name": "Project Synopsis", "type": "folder" }, "items": [ { "info": { "name": "Get-Project-Synopsis", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project/synopsis", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "kind", "value": "", "type": "query", "description": "Aggregation period; defaults to DAY. Matched case-insensitively, and any unrecognised value falls back to DAY." }, { "name": "time", "value": "", "type": "query", "description": "Selection point as ``%Y-%m-%dT%H:%MZ``. Defaults to the most recent generated period." }, { "name": "tz", "value": "", "type": "query", "description": "Optional timezone offset in minutes applied to ``time``." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the pre-aggregated synopsis for the current project." }, { "info": { "name": "Get-Organization-Synopsis", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project/organization/:org_id/", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "kind", "value": "", "type": "query", "description": "Aggregation period; defaults to DAY. Matched case-insensitively, and any unrecognised value falls back to DAY." }, { "name": "time", "value": "", "type": "query", "description": "Selection point as ``%Y-%m-%dT%H:%MZ``. Defaults to the most recent generated period." }, { "name": "tz", "value": "", "type": "query", "description": "Optional timezone offset in minutes applied to ``time``." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a rolled-up synopsis for every project the caller can see in an organization." } ] }, { "info": { "name": "Project Roles", "type": "folder" }, "items": [ { "info": { "name": "List-Project-Roles", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/roles/", "params": [ { "name": "project_key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List roles for a project." }, { "info": { "name": "Create-Project-Role", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/roles/", "params": [ { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a role on a project." }, { "info": { "name": "Get-Project-Role", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/roles/:project_role_id/", "params": [ { "name": "project_role_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a project role by id." }, { "info": { "name": "Update-Project-Role", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/roles/:project_role_id/", "params": [ { "name": "project_role_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a project role." }, { "info": { "name": "Delete-Project-Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/projects/:project_key_str/roles/:project_role_id/", "params": [ { "name": "project_role_id", "value": "", "type": "path" }, { "name": "project_key_str", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a project role." } ] }, { "info": { "name": "Project Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Subscribe-To-Project-Emails", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/project-subscriptions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Subscribe to email digests for the active project.\n\nSets which digest cadences (``daily``, ``weekly``, ``monthly``) the\ncaller receives for this project. A subsequent call replaces the\nprevious selection -- cadences omitted from ``options`` are\nunsubscribed. Returns the current subscription state." }, { "info": { "name": "Unsubscribe-From-Project-Emails", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/project-subscriptions/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unsubscribe from all email digests for the active project.\n\nIdempotent: returns ``{\"status\": \"OK\"}`` whether or not a\nsubscription existed." }, { "info": { "name": "List-Projects-Subscribed", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project-subscriptions/projects", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every project the caller is subscribed to across all projects.\n\nEach result includes the project the subscription applies to and\nwhich digest cadences the caller receives. Paginated via ``cursor``\nand ``limit``." }, { "info": { "name": "List-Projects-Subscribed-At-Level", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project-subscriptions/projects/:level", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "level", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every project the caller is subscribed to at the given digest level.\n\n``level`` is one of ``daily``, ``weekly``, or ``monthly``. Any other\nvalue returns an empty result set. Paginated via ``cursor`` and\n``limit``." }, { "info": { "name": "List-Accounts-Subscribed", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project-subscriptions/accounts/project/:project_key_str", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "project_key_str", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every account subscribed to this project's email digests.\n\nRequires project-admin access: the caller must be a site admin, an\nadmin of the project's organisation, or the owner of the project.\nReturns 404 for an unknown project id. Paginated via ``cursor``\nand ``limit``." }, { "info": { "name": "List-Accounts-Subscribed-At-Level", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/project-subscriptions/accounts/project/:project_key_str/:level", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "project_key_str", "value": "", "type": "path" }, { "name": "level", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List every account subscribed to this project's digests at the given level.\n\n``level`` is one of ``daily``, ``weekly``, or ``monthly``. Requires\nproject-admin access: the caller must be a site admin, an admin of\nthe project's organisation, or the owner of the project. Returns\n404 for an unknown project id. Paginated via ``cursor`` and\n``limit``." } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "List-Reports", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/reports/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List reports for the authenticated project." }, { "info": { "name": "Create-Report", "type": "http" }, "http": { "method": "POST", "url": "https://client.apimetrics.io/api/2/reports/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new report." }, { "info": { "name": "Get-Report", "type": "http" }, "http": { "method": "GET", "url": "https://client.apimetrics.io/api/2/reports/:report_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "report_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single report by id." }, { "info": { "name": "Update-Report", "type": "http" }, "http": { "method": "PUT", "url": "https://client.apimetrics.io/api/2/reports/:report_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "report_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update a report (only supplied fields change; groups are replaced)." }, { "info": { "name": "Delete-Report", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.apimetrics.io/api/2/reports/:report_id/", "headers": [ { "name": "apimetrics-project-id", "value": "" } ], "params": [ { "name": "report_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.apimetrics.io/authorize?audience=https://client.apimetrics.io", "accessTokenUrl": "https://auth.apimetrics.io/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a report and return its last representation." } ] } ], "bundled": true }