{ "info": { "_postman_id": "2f904b16-1098-4703-9905-217f73a5ec2c", "name": "API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Metrics", "item": [ { "name": "Names", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics/names", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics", "names" ] } }, "response": [] }, { "name": "Models", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics/models", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics", "models" ] } }, "response": [] }, { "name": "Endpoints Available KPI", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"start\": \"{{windowStart}}\",\n\t\"end\": \"{{windowEnd}}\",\n\t\"resultType\": \"kpi\",\n\t\"name\": \"endpoint.status.available\"\n}" }, "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics" ] } }, "response": [] }, { "name": "Endpoints Available Trend", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"start\": \"{{windowStart}}\",\n\t\"end\": \"{{windowEnd}}\",\n\t\"resultType\": \"trend\",\n\t\"name\": \"endpoint.status.available\"\n}" }, "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics" ] } }, "response": [] }, { "name": "Calls Min KPI", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"start\": \"{{windowStart}}\",\n\t\"end\": \"{{windowEnd}}\",\n\t\"resultType\": \"kpi\",\n\t\"name\": \"calls\",\n\t\"aggregation\": \"min\"\n}" }, "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics" ] } }, "response": [] }, { "name": "Calls Max KPI", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"start\": \"{{windowStart}}\",\n\t\"end\": \"{{windowEnd}}\",\n\t\"resultType\": \"kpi\",\n\t\"name\": \"calls\",\n\t\"aggregation\": \"max\"\n}" }, "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics" ] } }, "response": [] }, { "name": "Calls Trend", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"start\": \"{{windowStart}}\",\n\t\"end\": \"{{windowEnd}}\",\n\t\"resultType\": \"trend\",\n\t\"name\": \"calls\"\n}" }, "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/metrics", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "metrics" ] } }, "response": [] } ], "protocolProfileBehavior": {} }, { "name": "Authorization", "event": [ { "listen": "test", "script": { "id": "140c1fba-6455-465e-85b7-14bfecb1375f", "exec": [ "var data = JSON.parse(responseBody)", "pm.environment.set(\"accessToken\",data.access_token)" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" }, { "key": "Host", "value": "login.vyopta.com", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "password", "type": "text" }, { "key": "client_id", "value": "vyopta", "type": "text" }, { "key": "username", "value": "{{vyoptaU}}", "type": "text" }, { "key": "password", "value": "{{vyoptaP}}", "type": "text" } ] }, "url": { "raw": "https://login.vyopta.com/auth/realms/vyopta/protocol/openid-connect/token", "protocol": "https", "host": [ "login", "vyopta", "com" ], "path": [ "auth", "realms", "vyopta", "protocol", "openid-connect", "token" ] } }, "response": [] }, { "name": "Get Calls", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com:443/cpmm/api/v1/orgs/{{orgID}}/calls?start={{windowStart}}&end={{windowEnd}}", "protocol": "https", "host": [ "api", "vyopta", "com" ], "port": "443", "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "calls" ], "query": [ { "key": "start", "value": "{{windowStart}}", "description": "The beginning of the time window when the call would have been active (ISO date format)" }, { "key": "end", "value": "{{windowEnd}}", "description": "The end of the time window when the call would have been active (ISO date format)" }, { "key": "filter", "value": null, "description": "The criteria / filter for searching (optional)", "disabled": true }, { "key": "page", "value": "0", "description": "The criteria / filter for searching (optional)", "disabled": true }, { "key": "size", "value": "20", "description": "The number of results per page (optional, defaults to 20)", "disabled": true }, { "key": "sort", "value": null, "description": "The field and direction for sorting (optional)", "disabled": true } ] } }, "response": [] }, { "name": "Get Call Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com:443/cpmm/api/v2/orgs/{{orgID}}/calls/{{callID}}/{{callStartTime}}", "protocol": "https", "host": [ "api", "vyopta", "com" ], "port": "443", "path": [ "cpmm", "api", "v2", "orgs", "{{orgID}}", "calls", "{{callID}}", "{{callStartTime}}" ] } }, "response": [] }, { "name": "Get Call Quality Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com:443/cpmm/api/v2/orgs/{{orgID}}/calls/{{callID}}/{{callStartTime}}/quality", "protocol": "https", "host": [ "api", "vyopta", "com" ], "port": "443", "path": [ "cpmm", "api", "v2", "orgs", "{{orgID}}", "calls", "{{callID}}", "{{callStartTime}}", "quality" ], "query": [ { "key": "start", "value": null, "description": "(Optional) The start time in milliseconds (inclusive) since epoch to load quality metrics for the call. Defaults to the call start time.\n\n", "disabled": true }, { "key": "end", "value": null, "description": "(Optional) The end time in milliseconds (exclusive) since epoch to load quality metrics for the call. This can be a maximum of 2 hours later than the start time. Defaults to 2 hours after the start time.", "disabled": true }, { "key": "categories", "value": null, "description": "(Optional) A comma separated list of data categories. Defaults to 'tx_audio,rx_audio,tx_video,rx_video,tx_presentation,rx_presentation'.", "disabled": true }, { "key": "metrics", "value": null, "description": "(Optional) A comma separated list of quality metrics for the call. Defaults to 'jitter,packet_loss_rate' but can also include total_packet_loss_rate,bitrate,latency,framerate.", "disabled": true } ] } }, "response": [] }, { "name": "Get Call Records", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com:443/cpmm/api/v2/orgs/{{orgID}}/calls/{{callID}}/{{callStartTime}}callrecords", "protocol": "https", "host": [ "api", "vyopta", "com" ], "port": "443", "path": [ "cpmm", "api", "v2", "orgs", "{{orgID}}", "calls", "{{callID}}", "{{callStartTime}}callrecords" ] } }, "response": [] }, { "name": "Get Endpoints", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "page", "value": "0", "type": "text" } ], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/endpoints", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "endpoints" ], "query": [ { "key": "page", "value": "0", "description": "The page of results (optional, defaults to 0)", "disabled": true }, { "key": "size", "value": "20", "description": "The number of results per page (optional, defaults to 20)", "disabled": true }, { "key": "sort", "value": null, "description": "The field and direction for sorting (optional)", "disabled": true }, { "key": "filter", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Endpoints By Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "page", "type": "text", "value": "0" } ], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/endpoints?sort =status,desc", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "endpoints" ], "query": [ { "key": "sort ", "value": "status,desc" }, { "key": "page", "value": "0", "disabled": true }, { "key": "size", "value": "20", "disabled": true }, { "key": "filter", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Endpoint Details", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "page", "type": "text", "value": "0" } ], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/endpoints/{{endpointID}}", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "endpoints", "{{endpointID}}" ] } }, "response": [] }, { "name": "Delete a Peripheral from an Endpoint", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "page", "value": "0", "type": "text" } ], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/endpoints/{{endpointID}}/peripherals/{{peripheralID}}", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "endpoints", "{{endpointID}}", "peripherals", "{{peripheralID}}" ] } }, "response": [] }, { "name": "Get Systems", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/systems", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "systems" ], "query": [ { "key": "page", "value": "0", "description": "The page of results (optional, defaults to 0)", "disabled": true }, { "key": "size", "value": "20", "description": "The number of results per page (optional, defaults to 20, max 100)", "disabled": true }, { "key": "sort", "value": null, "description": "The field and direction for sorting (optional)", "disabled": true }, { "key": "filter", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Systems By Status", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/systems?sort=status,desc", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "systems" ], "query": [ { "key": "sort", "value": "status,desc" }, { "key": "page", "value": "0", "disabled": true }, { "key": "size ", "value": "20", "disabled": true }, { "key": "filter", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Systems With Status Not=OK", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/systems?sort=status,desc&page=0&filter=status!=OK", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "systems" ], "query": [ { "key": "sort", "value": "status,desc" }, { "key": "page", "value": "0" }, { "key": "filter", "value": "status!=OK" } ] } }, "response": [] }, { "name": "Get Trunks", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/trunks", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "trunks" ], "query": [ { "key": "page", "value": "0", "description": "The page of results (optional, defaults to 0)", "disabled": true }, { "key": "size", "value": "20", "description": "The number of results per page (optional, defaults to 20)", "disabled": true }, { "key": "sort", "value": null, "description": "The field and direction for sorting (optional)", "disabled": true }, { "key": "filter", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Meetings", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v1/orgs/{{orgID}}/meetings?start={{windowStart}}&end={{windowEnd}}&sort", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v1", "orgs", "{{orgID}}", "meetings" ], "query": [ { "key": "start", "value": "{{windowStart}}" }, { "key": "end", "value": "{{windowEnd}}" }, { "key": "filter", "value": "", "description": "The criteria / filter for searching (optional)", "disabled": true }, { "key": "page", "value": null, "description": "The page of results (optional, defaults to 0)", "disabled": true }, { "key": "size", "value": null, "description": "The number of results per page (optional, defaults to 20)", "disabled": true }, { "key": "sort", "value": null, "description": "The field and direction for sorting (optional)" } ] } }, "response": [] }, { "name": "Get Meeting Particpants", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{accessToken}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.vyopta.com/cpmm/api/v2/orgs/{{orgID}}/meetings/{{meetingID}}/{{meetingStartTime}}/participants", "protocol": "https", "host": [ "api", "vyopta", "com" ], "path": [ "cpmm", "api", "v2", "orgs", "{{orgID}}", "meetings", "{{meetingID}}", "{{meetingStartTime}}", "participants" ] } }, "response": [] } ], "protocolProfileBehavior": {} }