{ "opencollection": "1.0.0", "info": { "name": "Services Alerts Views API", "version": "v1" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Views", "type": "folder" }, "items": [ { "info": { "name": "List views", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" } ] }, "docs": "List views" }, { "info": { "name": "Create view", "type": "http" }, "http": { "method": "POST", "url": "https://api.overops.com/api/v1/services/:env_id/views", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create view" }, { "info": { "name": "Get view properties", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" } ] }, "docs": "Get full list of view properties" }, { "info": { "name": "Edit view data", "type": "http" }, "http": { "method": "POST", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edit view data" }, { "info": { "name": "Delete view", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" } ] }, "docs": "Delete view" }, { "info": { "name": "Fetch events details", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/events", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" }, { "name": "stats", "value": "", "type": "query", "description": "Include event volumes (e.g. number of event instances and calls into the method containing the event) in the response" } ] }, "docs": "Fetch events data for a target timeframe, application / server / deployment set." }, { "info": { "name": "Fetch stats for all events in the specified view", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/events/stats", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" }, { "name": "stats", "value": "", "type": "query", "description": "return only selected stats. 'all' is default." } ] }, "docs": "Fetch stats for a target timeframe, application / server / deployment set." }, { "info": { "name": "Fetch entry points details", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/entrypoints", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "Start time of requested events. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" } ] }, "docs": "Fetch entry points data in a selected timeframe" }, { "info": { "name": "Fetch event metrics split by view", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/metrics/view/graph", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "points", "value": "", "type": "query", "description": "Number of data points to return within the interval. **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "resolution", "value": "", "type": "query", "description": "Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" }, { "name": "stats", "value": "", "type": "query", "description": "Include statistics per event in the response" } ] }, "docs": "Fetch event metrics split by view" }, { "info": { "name": "Fetch event metrics split by entry point", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/metrics/entrypoint/graph", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "points", "value": "", "type": "query", "description": "Number of data points to return within the interval. **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "resolution", "value": "", "type": "query", "description": "Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" }, { "name": "stats", "value": "", "type": "query", "description": "Include statistics per event in the response" } ] }, "docs": "Fetch event metrics split by entry point" }, { "info": { "name": "Fetch event metrics split by event", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/metrics/event/graph", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" }, { "name": "from", "value": "", "type": "query", "description": "Start time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "to", "value": "", "type": "query", "description": "End time of requested graph. Date in ISO8601 format (yyyy-MM-ddTHH:mm:ss.SSSZ)" }, { "name": "points", "value": "", "type": "query", "description": "Number of data points to return within the interval. **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "resolution", "value": "", "type": "query", "description": "Select graph resolution (use M1/M5 for 1 point per 1/5 minutes; use H1/H8 for 1 point per 1/8 hours). **IMPORTANT:** either 'points' or 'resolution' parameters have to be passed. When both are passed, resolution takes precedence." }, { "name": "server", "value": "", "type": "query", "description": "Server(s) added to the filter" }, { "name": "app", "value": "", "type": "query", "description": "Application(s) added to the filter" }, { "name": "deployment", "value": "", "type": "query", "description": "Deployment(s) added to the filter" }, { "name": "stats", "value": "", "type": "query", "description": "Include statistics per event in the response" } ] }, "docs": "Fetch event metrics split by event" }, { "info": { "name": "Fetch View History", "type": "http" }, "http": { "method": "GET", "url": "https://api.overops.com/api/v1/services/:env_id/views/:view_id/history", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment to use" }, { "name": "view_id", "value": "", "type": "path", "description": "View to use" } ] }, "docs": "This call allows to get data about the creation and the last update to the view and provides information about the update initiator and timestamp." }, { "info": { "name": "Add view to selected category", "type": "http" }, "http": { "method": "POST", "url": "https://api.overops.com/api/v1/services/:env_id/categories/:category_id/views", "params": [ { "name": "env_id", "value": "", "type": "path", "description": "Environment ID to use (e.g. S1234)" }, { "name": "category_id", "value": "", "type": "path", "description": "View category to use" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add view to selected category" } ] } ], "bundled": true }