{ "info": { "_postman_id": "aaa4a43c-1ae4-443a-98d5-fff9c4186478", "name": "Amigo Account Metric API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:01:33.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "lastUpdatedBy": "35240", "uid": "35240-aaa4a43c-1ae4-443a-98d5-fff9c4186478" }, "item": [ { "name": "v1", "item": [ { "name": "{organization}", "item": [ { "name": "metric", "item": [ { "name": "{metric_id}", "item": [ { "name": "version", "item": [ { "name": "Create a new version for a metric", "id": "f47ca208-2c7b-4405-be83-19ae0f7d1ccd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "id": "27b1cccb-531c-43a0-a605-0472ac97be71", "key": "organization", "value": "", "description": "(Required) " }, { "id": "03cca8da-d848-4096-a85e-862bc7cb093d", "key": "metric_id", "value": "14ebd21ea2e7bdc6b39b33d9", "description": "(Required) The ID of the metric to create a new version for." } ] }, "description": "Create a new version for the given metric.\n\n#### Permissions:\nThis endpoint requires the following permissions:\n* `Metric:ModifyMetric` for the metric to create a new version for." }, "response": [ { "id": "bbd9448d-d0fc-4c8f-b40e-4411cd24c7a8", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": \"\"\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-bbd9448d-d0fc-4c8f-b40e-4411cd24c7a8" }, { "id": "bb744a44-4dd4-4606-9afc-986c568c0029", "name": "The metric value type cannot be changed between versions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-bb744a44-4dd4-4606-9afc-986c568c0029" }, { "id": "7b0d7acc-20d5-40d2-854e-8e41efad3a16", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-7b0d7acc-20d5-40d2-854e-8e41efad3a16" }, { "id": "07a60eb9-e354-4fe4-a5f9-faf2ef018413", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-07a60eb9-e354-4fe4-a5f9-faf2ef018413" }, { "id": "af23b89d-dd52-4ba6-b0e9-4af428997150", "name": "Specified organization or metric is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-af23b89d-dd52-4ba6-b0e9-4af428997150" }, { "id": "e2e46c5a-108e-4545-8cea-45bf181c48f0", "name": "The next version of the metric in the database doesn't match the specified version.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-e2e46c5a-108e-4545-8cea-45bf181c48f0" }, { "id": "9e5ea36b-760d-4de6-a4c5-da08d6d18565", "name": "Invalid request path parameter, request body, or request query parameter failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-9e5ea36b-760d-4de6-a4c5-da08d6d18565" }, { "id": "4b77bfd8-b72e-4987-bcad-6169e74ad119", "name": "The user has exceeded the rate limit of 60 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-4b77bfd8-b72e-4987-bcad-6169e74ad119" }, { "id": "f0d39350-5637-482e-8fd2-ef3ed1151c7d", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version", "" ], "query": [ { "description": "The version number of the new metric version. If specified, this endpoint throws an error if the next version of the metric in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f0d39350-5637-482e-8fd2-ef3ed1151c7d" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f47ca208-2c7b-4405-be83-19ae0f7d1ccd" }, { "name": "Get metric versions", "id": "b6355a66-83da-44b5-af18-9b5064a8ad74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "62908c20-5a2a-48c6-9b5c-c2cccaceb1db", "key": "organization", "value": "", "description": "(Required) " }, { "id": "1b9ce3ef-c40d-40f9-8cc8-7dc3f467e6db", "key": "metric_id", "value": "65e00032e5273195b6f37e2f", "description": "(Required) The ID of the metric to retrieve versions for." } ] }, "description": "Retrieve the versions of a metric.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Metric:GetMetric` for the metric whose versions to retrieve." }, "response": [ { "id": "64732764-7ccb-467e-a141-f87b339b6d71", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metric_versions\": [\n {\n \"metric_id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\"\n },\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"created_at\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"version\": \"\",\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\"\n },\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"created_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-64732764-7ccb-467e-a141-f87b339b6d71" }, { "id": "f0726f6e-3abe-49a6-a1da-ebd5d6f2c8cb", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f0726f6e-3abe-49a6-a1da-ebd5d6f2c8cb" }, { "id": "394d920f-184c-42a5-b7dd-d1ce89f0267d", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-394d920f-184c-42a5-b7dd-d1ce89f0267d" }, { "id": "985dd467-922d-452b-bbac-30a36a68d2ae", "name": "Specified organization or metric is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-985dd467-922d-452b-bbac-30a36a68d2ae" }, { "id": "4a438fdd-fc0e-4070-91d7-efd27e1f01c5", "name": "Invalid request path parameter or request query parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-4a438fdd-fc0e-4070-91d7-efd27e1f01c5" }, { "id": "b94ba66b-1f6b-444f-89e5-dad142ebca58", "name": "The user has exceeded the rate limit of 60 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-b94ba66b-1f6b-444f-89e5-dad142ebca58" }, { "id": "86ba114e-0547-4318-8703-61b1e731bd8a", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "version" ], "query": [ { "description": "The versions of the metric to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of metric versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of metric versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-86ba114e-0547-4318-8703-61b1e731bd8a" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-b6355a66-83da-44b5-af18-9b5064a8ad74" } ], "id": "c6b977d6-4945-430d-926f-d7dc71939b32", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-c6b977d6-4945-430d-926f-d7dc71939b32" }, { "name": "Update a metric", "id": "9679fb08-940d-4be4-a630-6e830058fa33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "id": "8b1f5288-d452-4375-832a-4ded0e2c99f6", "key": "organization", "value": "", "description": "(Required) " }, { "id": "e14d6741-3055-44d1-b786-d7afd8223e6b", "key": "metric_id", "value": "acb3920e9367114f9a9bf9f6", "description": "(Required) The ID of the metric to update." } ] }, "description": "Update properties of a metric. The metric's name and metric values cannot be updated.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Metric:ModifyMetric` for the metric to modify." }, "response": [ { "id": "82dc472f-acff-41dc-841a-78f3fd83612d", "name": "Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-82dc472f-acff-41dc-841a-78f3fd83612d" }, { "id": "28ba40ee-2d43-4c3a-98e6-1c55999b3982", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-28ba40ee-2d43-4c3a-98e6-1c55999b3982" }, { "id": "a134598d-e140-4199-8678-18f20c557e1a", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a134598d-e140-4199-8678-18f20c557e1a" }, { "id": "1d75a907-5b0c-4db3-b206-98e05520a2d3", "name": "Specified organization or metric is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-1d75a907-5b0c-4db3-b206-98e05520a2d3" }, { "id": "83894d46-aa34-4776-bf5c-7435487f86cd", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-83894d46-aa34-4776-bf5c-7435487f86cd" }, { "id": "3e62faaf-7ac7-49ee-b6b0-97deb5f3f032", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-3e62faaf-7ac7-49ee-b6b0-97deb5f3f032" }, { "id": "dab77035-9270-439f-ab56-b726d0dcd40d", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"applied_to_services\": [\n \"29539ae26bfb56bf88a8c09c\",\n \"77e0c3b070d5aa18c72d1907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"ut__a\": \"O\\fO\\u000bu\",\n \"eiusmod9\": \"q\\tG\u2009O1\",\n \"exercitation9\": \"I\",\n \"qui_14f\": \"\u00a0ZxJ\\f\",\n \"qui_23\": \"z\",\n \"nostrud26\": \"\u2002\u2007R\u2006bOQ\",\n \"anim1\": \"e\u2003\u2009sj\u2008b9\",\n \"laborum6a\": \"O5v5ru\u2009mulD\",\n \"est3c7\": \"Y\u2003UG\u2008oeBRCh\",\n \"cillum_71\": \"S\\u000b8Iav\\tWg\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-dab77035-9270-439f-ab56-b726d0dcd40d" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-9679fb08-940d-4be4-a630-6e830058fa33" }, { "name": "Delete a metric", "id": "2afc05da-63f7-4914-b063-d0754d957d28", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "id": "dabb22c2-13d2-4db1-9bda-29b922084f4c", "key": "organization", "value": "", "description": "(Required) " }, { "id": "ea3b02df-0bd8-4a59-afd4-57179093e39d", "key": "metric_id", "value": "acb3920e9367114f9a9bf9f6", "description": "(Required) The ID of the metric to update." } ] }, "description": "Delete a metric. The metric is no longer modifiable or manually evaluable, but remains stored, and existing services or simulations that evaluate this metric\nwill continue to do so. One can still retrieve it using its ID to view its specifics.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Metric:DeleteMetric` for the metric to delete." }, "response": [ { "id": "b1e05a72-7ae9-4875-a335-961f351eab76", "name": "Succeeded.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-b1e05a72-7ae9-4875-a335-961f351eab76" }, { "id": "e399b7d6-062a-4720-8e48-28d6063aeeaa", "name": "Metric is used in a simulation unit test.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-e399b7d6-062a-4720-8e48-28d6063aeeaa" }, { "id": "c40767af-af4b-40ea-914b-3255ef1bc931", "name": "Invalid authorization credentials.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-c40767af-af4b-40ea-914b-3255ef1bc931" }, { "id": "1ecbcd8d-6afb-4817-8bef-654c64471bda", "name": "Missing required permissions.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-1ecbcd8d-6afb-4817-8bef-654c64471bda" }, { "id": "56c51f5b-23b4-4958-98e0-674963ad7d45", "name": "Specified organization or metric is not found.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-56c51f5b-23b4-4958-98e0-674963ad7d45" }, { "id": "3036e4ce-0f39-47db-896e-b95e2575faa1", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-3036e4ce-0f39-47db-896e-b95e2575faa1" }, { "id": "ba5b738a-4309-4f94-a4d9-102bd3f3124a", "name": "The user has exceeded the rate limit of 100 requests per minute for this endpoint.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-ba5b738a-4309-4f94-a4d9-102bd3f3124a" }, { "id": "01b5e6bb-240b-449f-8775-ad8e973c7948", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "DELETE", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/:metric_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", ":metric_id", "" ], "variable": [ { "key": "organization" }, { "key": "metric_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-01b5e6bb-240b-449f-8775-ad8e973c7948" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-2afc05da-63f7-4914-b063-d0754d957d28" } ], "id": "f55bb170-7c87-4dd0-9c6c-2f212aabee9c", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f55bb170-7c87-4dd0-9c6c-2f212aabee9c" }, { "name": "search", "item": [ { "name": "Search metrics", "id": "ba25681f-280c-42a2-b7f7-81e47f9b75ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "id": "23fee28c-ad77-4104-bd6c-281f077ddd4e", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Search for metrics that match the given filters and contain the given query in its name. Only the top 50 results will be returned. The results\nwill be sorted by the relevance of the search query.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* Only metrics that the authenticated user has `Metric:GetMetric` permission for will be retrieved." }, "response": [ { "id": "cd91da9c-cf2f-4d06-85ab-468e3b8339c1", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metrics\": [\n {\n \"_id\": \"\",\n \"org_id\": \"\",\n \"name\": \"\",\n \"applied_to_services\": [\n \"\",\n \"\"\n ],\n \"additional_notes\": \"\",\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"updated_by\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"metric_value_type\": \"numerical\",\n \"is_deleted\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"_id\": \"\",\n \"org_id\": \"\",\n \"name\": \"\",\n \"applied_to_services\": [\n \"\",\n \"\"\n ],\n \"additional_notes\": \"\",\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"updated_by\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"metric_value_type\": \"numerical\",\n \"is_deleted\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-cd91da9c-cf2f-4d06-85ab-468e3b8339c1" }, { "id": "0075fc4b-6447-452b-87bb-dcc73b2103ec", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-0075fc4b-6447-452b-87bb-dcc73b2103ec" }, { "id": "3512941d-efdb-47e4-be2b-5a296ee230f8", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-3512941d-efdb-47e4-be2b-5a296ee230f8" }, { "id": "2f1f4411-6ce0-4083-898d-dd719ad01f1d", "name": "Specified organization is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-2f1f4411-6ce0-4083-898d-dd719ad01f1d" }, { "id": "6994fc60-e221-4537-898e-dff1d0640c3d", "name": "Invalid request path parameter or request query parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-6994fc60-e221-4537-898e-dff1d0640c3d" }, { "id": "6e969567-9bbc-49aa-8db0-917c14293b56", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-6e969567-9bbc-49aa-8db0-917c14293b56" }, { "id": "a89cd66e-d06a-4537-ae73-a5215cea17bc", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/search/?query=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "search", "" ], "query": [ { "description": "(Required) The query to search for. Any metrics containing the terms in its name would be returned.", "key": "query", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a89cd66e-d06a-4537-ae73-a5215cea17bc" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-ba25681f-280c-42a2-b7f7-81e47f9b75ae" } ], "id": "ee9c3f9a-6550-41e0-9d33-6cd82ab1cf57", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-ee9c3f9a-6550-41e0-9d33-6cd82ab1cf57" }, { "name": "evaluate", "item": [ { "name": "Evaluate metrics", "id": "38cae619-3b13-4f44-b67a-388fdf911278", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "id": "40121e1d-cf2e-4fec-b9a6-8b5eb01c76d8", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Evaluate the latest versions of specified metrics for a completed conversation. The results will be stored and retrievable through the [`GetMetricEvaluationResults`](get-metric-evaluation-results)\nendpoint with a special source type of `manual`.\n\nIf the same conversation has been manually evaluated for the same metric, the previous evaluation result will be overwritten.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Metric:GetMetric` for the metrics.\n* `Metric:EvaluateMetric` for the metrics.\n* `Metric:GetMetricEvaluationResult` for the metric results." }, "response": [ { "id": "5e111f5a-042f-41b7-bcd2-423c275deb72", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metrics\": [\n {\n \"metric_id\": \"\",\n \"value\": \"\",\n \"references\": [\n \"\",\n \"\"\n ],\n \"justification\": \"\"\n },\n {\n \"metric_id\": \"\",\n \"value\": \"\",\n \"references\": [\n \"\",\n \"\"\n ],\n \"justification\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-5e111f5a-042f-41b7-bcd2-423c275deb72" }, { "id": "3cc367df-40ff-4f96-a01d-be3480169d39", "name": "The conversation has no interactions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-3cc367df-40ff-4f96-a01d-be3480169d39" }, { "id": "a82a851b-38f9-4387-926a-4a2a6957cf21", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a82a851b-38f9-4387-926a-4a2a6957cf21" }, { "id": "309a84f3-c33c-403e-b480-c7353030af8a", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-309a84f3-c33c-403e-b480-c7353030af8a" }, { "id": "44cbde95-6322-4232-9033-d9a157b9b618", "name": "Specified organization, conversation, or metric is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-44cbde95-6322-4232-9033-d9a157b9b618" }, { "id": "a82b9654-6572-4ba6-9245-902efce985f7", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a82b9654-6572-4ba6-9245-902efce985f7" }, { "id": "32d8c254-86d8-41fd-a33d-bfc5c61933fa", "name": "The user has exceeded the rate limit of 50 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-32d8c254-86d8-41fd-a33d-bfc5c61933fa" }, { "id": "a16617b1-000f-4355-a174-0cea8c2c5112", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"metric_ids\": [\n \"bbddaa7f5467a30141bc5e77\"\n ],\n \"conversation_id\": \"81e05f97528d8b56a65bb026\",\n \"evaluate_to_interaction_id\": \"9c0e52fb7422eea095ee3a1a\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "evaluate" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a16617b1-000f-4355-a174-0cea8c2c5112" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-38cae619-3b13-4f44-b67a-388fdf911278" } ], "id": "4dc36bb5-67c4-4ac3-bb5f-6565bf5991b9", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-4dc36bb5-67c4-4ac3-bb5f-6565bf5991b9" }, { "name": "metric_evaluation_result", "item": [ { "name": "Get metric evaluation results", "id": "c558cddc-be94-47bc-8f7c-efd433f97e1f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "id": "c661410f-366f-4ee1-84fa-9a10f7d1d1b2", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Retrieve metric evaluation results that match the given filters.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* Only metric evaluation results that the authenticated user has `Metric:GetMetricEvaluationResult` permission for will be retrieved." }, "response": [ { "id": "e1935981-e047-4a36-ab10-8a67f969a83d", "name": "Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metric_evaluation_results\": [\n {\n \"id\": \"\",\n \"org_id\": \"\",\n \"metric_id\": \"\",\n \"metric_version\": \"\",\n \"result\": \"\",\n \"justification\": \"\",\n \"source\": {\n \"conversation_id\": \"\",\n \"references\": [\n \"\",\n \"\"\n ],\n \"type\": \"post-session\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"org_id\": \"\",\n \"metric_id\": \"\",\n \"metric_version\": \"\",\n \"result\": \"\",\n \"justification\": \"\",\n \"source\": {\n \"conversation_id\": \"\",\n \"references\": [\n \"\",\n \"\"\n ],\n \"type\": \"post-session\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": {},\n \"filter_values\": {\n \"metric_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-e1935981-e047-4a36-ab10-8a67f969a83d" }, { "id": "edbe23c5-09c7-4fef-a409-4485ee9638f3", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-edbe23c5-09c7-4fef-a409-4485ee9638f3" }, { "id": "a14ee496-4c43-49bb-a9e8-be3ad0da265f", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a14ee496-4c43-49bb-a9e8-be3ad0da265f" }, { "id": "fea25630-9543-4575-a28d-4888f3e2b1e4", "name": "Specified organization is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-fea25630-9543-4575-a28d-4888f3e2b1e4" }, { "id": "e782a8ef-b699-406d-acc6-a0ff4c504d9b", "name": "Invalid request path parameter or request query parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-e782a8ef-b699-406d-acc6-a0ff4c504d9b" }, { "id": "010e7658-e97b-4c98-b4da-b696456943b3", "name": "The user has exceeded the rate limit of 10 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-010e7658-e97b-4c98-b4da-b696456943b3" }, { "id": "0c5f8eeb-e7a6-4103-8484-27b536323191", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/metric_evaluation_result?limit=500&continuation_token=0×tamp_after=×tamp_before=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "metric_evaluation_result" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "500" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "An ISO8601 timestamp. Only results evaluated on or after this moment is returned.", "key": "timestamp_after", "value": "" }, { "description": "An ISO8601 timestamp. Only results evaluated on or before this moment is returned.", "key": "timestamp_before", "value": "" } ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-0c5f8eeb-e7a6-4103-8484-27b536323191" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-c558cddc-be94-47bc-8f7c-efd433f97e1f" } ], "id": "97b458c9-fbea-4a2d-919d-68164fd76709", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-97b458c9-fbea-4a2d-919d-68164fd76709" }, { "name": "Create a metric", "id": "d2ddd1e9-ca91-4501-8528-bff4e885ed8f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "id": "b573a615-5430-46fb-8c5c-b8c1ae548e30", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Create a metric.\n\n#### Permissions\n* `Metric:CreateMetric` for the metric to create." }, "response": [ { "id": "57c73e3e-d0b1-474f-bbae-56e630253e76", "name": "Succeeded", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-57c73e3e-d0b1-474f-bbae-56e630253e76" }, { "id": "990ec069-ee74-4702-86a8-5ed71a0fb3cf", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-990ec069-ee74-4702-86a8-5ed71a0fb3cf" }, { "id": "f4217e03-c5f6-4404-b4a0-18793c23265e", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f4217e03-c5f6-4404-b4a0-18793c23265e" }, { "id": "48746314-315c-435f-b54e-958c06e8ce5e", "name": "Specified organization is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-48746314-315c-435f-b54e-958c06e8ce5e" }, { "id": "a1970c0a-235f-45ab-995a-ab8a43019154", "name": "A metric with this name already exists", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-a1970c0a-235f-45ab-995a-ab8a43019154" }, { "id": "06307a8c-02d0-4e13-a5fd-36eeec5d6db5", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-06307a8c-02d0-4e13-a5fd-36eeec5d6db5" }, { "id": "fd6b45f2-52d9-4a31-bb1f-bd8cbf25fee7", "name": "The user has exceeded the rate limit of 100 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-fd6b45f2-52d9-4a31-bb1f-bd8cbf25fee7" }, { "id": "b1305202-8e86-4bf7-a57c-8e1477614a10", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"applied_to_services\": [\n \"82fbb7fe17a9e425f6023cd1\",\n \"53ea8e1d8c2986da031d2907\"\n ],\n \"additional_notes\": \"\",\n \"tags\": {\n \"elitc\": \"e\",\n \"veniam7b2\": \"\u2006\\tvo9ff\u2006mC\",\n \"minim9\": \"\\ne7Z\u2004\",\n \"enim8c\": \"\u2008\u2009\u1680\u2008\",\n \"culpa_d9\": \"m3\",\n \"dolor__\": \"0Ln\",\n \"consectetur8a\": \"AX\u3000Y\\tS88\",\n \"dolor_06\": \"\\r\u2003R rz\u2000H\u2008\u2000\",\n \"officia_a\": \"Z\u2003\u00a0\u2000\u2005B\",\n \"sint_519\": \"8upm1\",\n \"magna__de\": \"\u1680\u2028dtc3\u2028\u30005\u2029P\",\n \"consequat5ce\": \"Am\ufeff\u2005jj\u2000LJ\",\n \"sit_d29\": \"qfk\u2003Z\\fE9S0\",\n \"velit_9\": \"eVG\u202fL3ik_\",\n \"dolor_5\": \"\ufeffPq\u2009\u205fr\u2004u\",\n \"ipsum74\": \"\u20282n\u2005\u2007Rue\",\n \"reprehenderit80\": \"\u2005\"\n },\n \"initial_version_metric_value\": {\n \"description\": \"\",\n \"metric_value\": {\n \"type\": \"\",\n \"lower_bound\": \"\",\n \"upper_bound\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/metric/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-b1305202-8e86-4bf7-a57c-8e1477614a10" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-d2ddd1e9-ca91-4501-8528-bff4e885ed8f" }, { "name": "Get metrics", "id": "4bf723d2-556f-4b4f-8bd7-5163b15cd669", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "id": "225fab0c-d491-4fbb-b0c0-9252b4b47a53", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Retrieve metrics that match the given filters.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* Only metrics that the authenticated user has `Metric:GetMetric` permission for will be retrieved." }, "response": [ { "id": "f306ee75-09ca-4d2a-a550-2c8c1f83931b", "name": "Succeeded", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"metrics\": [\n {\n \"id\": \"\",\n \"org_id\": \"\",\n \"name\": \"\",\n \"applied_to_services\": [\n \"\",\n \"\"\n ],\n \"additional_notes\": \"\",\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"updated_by\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"metric_value_type\": \"numerical\",\n \"is_deleted\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"org_id\": \"\",\n \"name\": \"\",\n \"applied_to_services\": [\n \"\",\n \"\"\n ],\n \"additional_notes\": \"\",\n \"tags\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"updated_by\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"metric_value_type\": \"numerical\",\n \"is_deleted\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": {},\n \"filter_values\": {\n \"applied_to_services_ids\": [\n \"\",\n \"\"\n ],\n \"creators\": [\n {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n {\n \"org_id\": \"\",\n \"user_id\": \"\"\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"types\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-f306ee75-09ca-4d2a-a550-2c8c1f83931b" }, { "id": "c7ea5c51-525d-4ab0-9f4e-4953b584e65f", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-c7ea5c51-525d-4ab0-9f4e-4953b584e65f" }, { "id": "8357ac82-d441-4aae-850e-f2682788b6e8", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-8357ac82-d441-4aae-850e-f2682788b6e8" }, { "id": "e620aef4-d6c3-4e51-8ff1-80234589085f", "name": "Specified organization is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-e620aef4-d6c3-4e51-8ff1-80234589085f" }, { "id": "152dbee4-cac3-44ce-a731-ecf6f8040b18", "name": "Invalid request path parameter or request query parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-152dbee4-cac3-44ce-a731-ecf6f8040b18" }, { "id": "259b20c4-dcac-4596-abd8-f15bb6d5c7de", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-259b20c4-dcac-4596-abd8-f15bb6d5c7de" }, { "id": "617093e5-9bc4-4396-a242-c9a98b3fa73f", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/metric/?limit=50&continuation_token=0&is_deleted=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "metric", "" ], "query": [ { "description": "The maximum number of metrics to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of metrics.", "key": "continuation_token", "value": "0" }, { "description": "Whether the metric is deleted.", "key": "is_deleted", "value": "false" } ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-617093e5-9bc4-4396-a242-c9a98b3fa73f" } ], "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-4bf723d2-556f-4b4f-8bd7-5163b15cd669" } ], "id": "1e620053-c8ee-4398-a51f-8fbccbab13ad", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-1e620053-c8ee-4398-a51f-8fbccbab13ad" } ], "id": "9328b9ec-cc6e-43db-b6aa-9c1247075369", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-9328b9ec-cc6e-43db-b6aa-9c1247075369" } ], "id": "8a5e2e8f-e492-448f-89d5-97642925c805", "createdAt": "2026-07-28T01:01:34.000Z", "updatedAt": "2026-07-28T01:01:34.000Z", "uid": "35240-8a5e2e8f-e492-448f-89d5-97642925c805" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.amigo.ai" } ] }