openapi: 3.0.0 info: title: Reporting version: 2.0.0 description: Reporting apps management API Documentation contact: name: OpsRamp Support email: support@opsramp.com url: 'https://www.opsramp.com/about-opsramp/contact-us/' servers: - url: 'https://api.opsramp.com' description: Partner - All Others - url: 'https://{subdomain}.api.opsramp.com' description: Partner or Client custom branded sub-domain variables: subdomain: default: demo description: Custom sub-domain assigned to the client paths: '/reporting/api/v3/tenants/{tenantId}/available-apps': summary: available-apps description: List available reporting apps. x-new-path: true x-internal: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true get: summary: Search available reporting apps operationId: get-avaliable-list-of-reporting-apps responses: '200': $ref: '#/components/responses/paginatedApps' description: Search available reporting apps. parameters: - schema: type: boolean enum: - true - false in: query name: sortOrder description: Sorting order of the resultset. 'True' for descendingOrder - schema: type: string in: query name: name description: Name of the app tags: - runs '/reporting/api/v3/tenants/{tenantId}/apps': summary: apps description: Manage reporting apps. x-new-path: true x-internal: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true post: summary: Installs a reporting app. operationId: reporting-apps-install tags: - analytics - runs description: Installs a reporting app. requestBody: $ref: '#/components/requestBodies/reportingApps' responses: '201': $ref: '#/components/responses/appId' get: summary: Search the installed reporting apps operationId: get-list-of-installed-reporting-apps responses: '200': $ref: '#/components/responses/paginatedApps' description: Search installed reporting apps. parameters: - $ref: '#/components/parameters/appId' - $ref: '#/components/parameters/status' - schema: type: boolean enum: - true - false in: query name: sortOrder description: Sorting order of the resultset. 'True' for descendingOrder - schema: type: string in: query name: sortBy description: 'Sorting fields by id, status, createdDate, appId' tags: - runs delete: summary: Uninstall reporting app operationId: reporting-apps-uninstall responses: '200': $ref: '#/components/responses/message' description: Uninstalls the installed reporting apps '/reporting/api/v3/tenants/{tenantId}/runs': summary: runs description: | Search and creates runs of reporting app. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - $ref: '#/components/parameters/tenantId' post: summary: Create reporting app execution. operationId: analytics-post-runs requestBody: content: application/json: schema: type: object x-examples: Example 1: appId: ALERT-LISTING parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' format: - xlsx properties: parameters: type: object properties: analysisPeriod: type: string client: type: string appId: type: string format: type: array items: type: string analysisId: type: string examples: example-runs: value: parameters: analysisPeriod: Last 24 Hours client: 4lm12e3f-435d-5321-7ght-e722321ac911 appId: ALERT-LISTING format: - xlsx example-runs-with-analysisId: value: parameters: analysisPeriod: Last 24 Hours client: 4lm12e3f-435d-5321-7ght-e722321ac911 appId: ALERT-LISTING format: - xlsx analysisId: 4635ec0a-10dd-4734-b107-e2375d28e60d description: '' tags: - analytics - runs responses: '201': description: Created content: application/json: schema: type: object properties: id: type: string x-examples: Example 1: id: 6e57eb3f-f6bf-4f89-a929-e3959b03ac70 examples: run-example: value: id: 6e57eb3f-f6bf-4f89-a929-e3959b03ac70 description: |- Note: To use this API, you must have the REPORTS_MANAGE permission assigned. Create run of an reporting app. get: summary: Search reporting app runs operationId: get-analytics-runs responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string appId: type: string tenantId: type: string parameters: type: object properties: options: type: array items: type: string opsqlQuery: type: array items: type: object properties: groupBy: type: array items: type: object properties: {} filterCriteria: type: string createdBy: type: object properties: id: type: string loginName: type: string firstName: type: string lastName: type: string createdDate: type: string status: type: string format: type: array items: type: string failureReason: type: string completedTime: type: string analysisId: type: string totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean x-examples: Example 1: results: - id: 5daebef5-bd6b-4b4a-bdf7-2d3b9699009b appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:11:43+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:33+0000' - id: 7cdebee4-c986-484e-a098-236440a5bb14 appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:12:09+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:58+0000' - id: 19a884ff-00bd-4200-9c77-6efae6bb87ab appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:13:27+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:14:07+0000' - id: 673836e5-5980-4fba-96db-e88ef08a30e4 appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:19:58+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:20:39+0000' - id: 6b087ad5-33a0-448d-a62b-5df6a64c0120 appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-14T09:14:02+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-14T09:14:44+0000' - id: ec48dabc-517b-4cac-a947-bc49ecd7d1f2 appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-15T15:30:03+0000' status: failed format: - xlsx analysisId: 4084fdb4-dfc3-40e0-97f7-122c8cdefb1c failureReason: API processing failed completedTime: '2024-02-15T15:30:49+0000' totalResults: 6 orderBy: createdDate pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true examples: runs-example1: value: descendingOrder: true nextPage: false orderBy: createdDate pageNo: 1 pageSize: 100 previousPageNo: 0 results: - id: 5daebef5-bd6b-4b4a-bdf7-2d3b9699009b appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:11:43+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:33+0000' - id: 7cdebee4-c986-484e-a098-236440a5bb14 appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:12:09+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:58+0000' totalPages: 1 totalResults: 2 description: |- Note: To use this API, you must have the REPORTS_VIEW permission assigned. Search runs of reporting app. parameters: - $ref: '#/components/parameters/appId' - $ref: '#/components/parameters/status' - schema: type: boolean enum: - true - false in: query name: sortOrder description: Sorting order of the resultset. 'True' for descendingOrder - schema: type: string in: query name: sortBy description: 'Sorting fields by id, status, createdDate, appId' - schema: type: string in: query name: analysisId description: Filter runs by analysis id tags: - runs '/reporting/api/v3/tenants/{tenantId}/runs/{id}': summary: 'runs/{id}' description: | Get details of given run of an reporting app. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true - schema: type: string name: id in: path required: true description: Describes run uuid of runs on the reporting app get: summary: Get details of given runs tags: - analytics - runs operationId: analytics-runs-id-get responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string appId: type: string tenantId: type: string parameters: type: object properties: options: type: array items: type: string opsqlQuery: type: array items: type: object properties: groupBy: type: array items: type: object properties: {} filterCriteria: type: string createdBy: type: object properties: id: type: string loginName: type: string firstName: type: string lastName: type: string createdDate: type: string status: type: string format: type: array items: type: string failureReason: type: string completedTime: type: string x-examples: Example 1: id: 5daebef5-bd6b-4b4a-bdf7-2d3b9699009b appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:11:43+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:33+0000' examples: run-details-example: value: id: 5daebef5-bd6b-4b4a-bdf7-2d3b9699009b appId: ALERT-LISTING tenantId: 6cf6434b-1495-4ce4-bc87-b2ce738ac003 parameters: options: - id - objectName - objectType - ipAddress - subject - metric - currentState - createdTime - isInferenceAlert - inferenceId opsqlQuery: - groupBy: [] filterCriteria: 'status IN ("OPEN", "ACKNOWLEDGED", "TICKETED", "CORRELATED", "SUPPRESSED") AND updatedTime >= "-7d"' createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2024-02-13T15:11:43+0000' status: failed format: - xlsx failureReason: API processing failed completedTime: '2024-02-13T15:12:33+0000' description: |- Note: To use this API, you must have the REPORTS_VIEW permission assigned. Get details of the given run of reporting app parameters: [] '/reporting/api/v3/tenants/{tenantId}/runs/{id}/downloads': summary: 'runs/{id}/downloads' description: | Downloads analysis against a given run in the supported formats. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - $ref: '#/components/parameters/tenantId' - schema: type: string name: id in: path required: true description: Describes run uuid of runs on the reporting app get: summary: Downloads analysis. tags: - analytics responses: '200': description: OK content: application/pdf: schema: type: string format: binary examples: example-download: value: binary format headers: Content-Disposition: schema: type: string description: Used only with `application/pdf` responses example: 'attachment; filename="{{app_name}}.{{time_stamp}}.pdf"' enum: - 'attachment; filename="{{app_name}}.{{time_stamp}}.pdf"' - 'attachment; filename="{{app_name}}.{{time_stamp}}.xlsx"' - 'attachment; filename="{{app_name}}.{{time_stamp}}.csv"' description: 'Report download in the supported format . ' Pragma: schema: type: string default: cache example: cache description: Cache Cache-Control: schema: type: string example: cache default: cache description: Cache Control Content-Encoding: schema: type: string example: ISO-8859-1 default: ISO-8859-1 description: Report content encoding format operationId: get_analysis_downloads description: |- Note: To use this API, you must have the REPORTS_VIEW permission assigned. Dowloads run analysis. ### Example URL - {base_url}/analytics/api/v3/tenants/{tenantId}/runs/{runId}/downloads?format=pdf - Downloads a given format at a time. - supported response headers. To be used based on the format chosen to download - application/pdf - application/xlsx parameters: - schema: type: string enum: - xlsx - pdf in: query name: format description: Supported format for analysis downloads '/reporting/api/v3/tenants/{tenantId}/runs/queries': summary: runs/queries description: Search and filter runs of the reporting app. x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' post: summary: Queries - POST tags: - analytics responses: '200': $ref: '#/components/responses/paginatedSprints' operationId: get-analytics-api-v3-tenants-tenantId-operations-queries requestBody: $ref: '#/components/requestBodies/query' description: Post the request to query runs of reporting apps. '/reporting/api/v3/tenants/{tenantId}/analyses': summary: analyses description: | Search analysis and create analysis of reporting app **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - $ref: '#/components/parameters/tenantId' post: summary: App analysis operationId: analytics-analysis-post requestBody: content: application/json: schema: $ref: '#/components/schemas/analysis' examples: example-analysis-with-name: value: appId: ALERT-LISTING name: Analysis-001 parameters: analysisPeriod: Last 24 Hours description: '' tags: - analytics responses: '201': $ref: '#/components/responses/analysisId' description: |- Note: To use this API, you must have the REPORTS_MANAGE permission assigned. Create analysis of reporting app. get: summary: Search reporting app executions. operationId: analytics-analysis-get responses: '200': $ref: '#/components/responses/paginatedAnalysis' description: Search analysis of reporting app. parameters: - schema: type: string in: query name: appId description: Filter executions based on reporting appId tags: - analytics '/reporting/api/v3/tenants/{tenantId}/analyses/{id}': summary: 'analyses/{id}' description: | 'Update, get details of given analysis of an reporting app.' **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true - schema: type: string name: id in: path required: true description: Describes analysis uuid of the analyses of the reporting app get: summary: Update and Get given Sprint Details. tags: - analytics operationId: get-analytics-analysis-id responses: '200': $ref: '#/components/responses/analysis' description: |- Note: To use this API, you must have the REPORTS_VIEW permission assigned. Get details of the given analysis of reporting app. put: summary: '' operationId: put-analytics-analysis-id responses: '200': $ref: '#/components/responses/analysisId' tags: - analytics description: |- Note: To use this API, you must have the REPORTS_MANAGE permission assigned. Update the analysis of reporting app requestBody: $ref: '#/components/requestBodies/update-analysis' '/reporting/api/v3/tenants/{tenantId}/scheduled-runs': summary: scheduled-runs description: | Create and search schedules of reporting apps **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true post: summary: Create reporting app execution. operationId: analytics-schedule-post requestBody: content: application/json: schema: $ref: '#/components/schemas/schedules' examples: example-schedule-daily: value: name: schedule-001 analysisId: bf81b13e-7407-4deb-9213-3843375051ec schedule: type: recurring startTime: '2022-05-19T15:30:00+0000' startDate: '2022-05-19T00:00:00+0000' pattern: type: daily repeatFrequency: '2' timezone: America/Los_Angeles recipients: - USR0000000002 - USR0000000003 - USR0000004002 subject: 'Subject : Asset Insights' message: Asset-Insights app mail format: - pdf - xlsx example-schedule-monthly: value: name: schedule-002 analysisId: fd4494a5-4812-4d5b-bf0f-ecc605f22cbb schedule: type: recurring startTime: '2022-05-18T15:30:00+0000' startDate: '2022-05-18T00:00:00+0000' pattern: type: monthly dayOfMonth: '01, 15' timezone: America/Los_Angeles recipients: - USR0000000002 - USR0000004002 subject: 'Subject : Asset Insights' message: Asset-Insights app mail format: - pdf - xlsx example-schedule-daily-with-repeat-freq: value: name: Test-schedule analysisId: b5c2bebf-2784-4a86-96e2-0551243e79a5 schedule: type: recurring startTime: '2022-06-27T00:00:00+0000' pattern: type: weekly weekDays: 'sunday,monday,tuesday,wednesday,thursday,Friday,saturday' timezone: Asia/kolkata subject: 'Subject : Asset Insights' message: Asset-Insights app reprt mail format: - pdf - xlsx parameters: analysisPeriod: Last 24 Hours description: '' tags: - analytics responses: '201': $ref: '#/components/responses/schedulesId' description: |- Note: To use this API, you must have the REPORTS_MANAGE permission assigned. Create schedule of an reporting app. '/reporting/api/v3/tenants/{tenantId}/scheduled-runs/{id}': summary: 'scheduled-runs/{id}' description: | 'Update, get details of a given schedule of reporting app.' **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true parameters: - in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true - schema: type: string name: id in: path required: true description: Describes schedule uuid of runs on the reporting app get: summary: Update and Get given schedule details. tags: - analytics operationId: get-analytics-schedule-id responses: '200': $ref: '#/components/responses/schedules' description: |- Note: To use this API, you must have the REPORTS_VIEW permission assigned. Get the details of schedule of reporting app put: summary: '' operationId: put-analytics-schedule-id responses: '200': $ref: '#/components/responses/analysisId' tags: - analytics description: |- Note: To use this API, you must have the REPORTS_MANAGE permission assigned. Update the schedule of reproting app. requestBody: $ref: '#/components/requestBodies/update-schedules' '/reporting/api/v3/tenants/{tenantId}/dashboard-analyses': summary: dashboard-analyses description: | Manage dashboard analyses for reporting. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' post: summary: Create dashboard analysis operationId: dashboard-analyses-post requestBody: content: application/json: schema: type: object properties: parameters: type: object properties: analysisPeriod: type: string variablesMap: type: object additionalProperties: type: string dashboardId: type: string name: type: string schedules: type: array items: $ref: '#/components/schemas/ScheduleWithNotification' required: - parameters - dashboardId - name examples: dashboard-analysis-example: value: parameters: analysisPeriod: "Last 24 hours" variablesMap: Reports: "storage1" Reports1: "storage2" dashboardId: "at4df71-8c1f-4791-9d53-0e00150b5488" name: "Monthly Dashboard Analysis" schedules: - schedule: type: "recurring" startTime: "2024-05-10T00:00:00+0000" pattern: type: "monthly" dayOfMonth: "1" timezone: "Asia/Calcutta" subject: "Dashboard analysis report" message: "Dashboard analysis report" recipients: - "USR0000000045" format: - "pdf" tags: - dashboard-analyses responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string examples: analysis-created: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" description: |- Create dashboard analysis with optional scheduling. get: summary: Search dashboard analyses operationId: get-dashboard-analyses responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/DashboardAnalysis' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: dashboard-analyses-list: value: results: - id: b315c6f6-7a07-4416-8355-c933a4959320 name: Monthly Dashboard Analysis1 parameters: analysisPeriod: Last 24 hours variablesMap: Reports: storage1 Reports1: storage2 dashboardId: at4df71-8c1f-4791-9d53-0e00150b5488 createdBy: id: USR0000000022 lastName: QA firstName: opsramp loginName: opsrampqa schedules: - id: c513c6f6-7a07-4416-8355-c463a4959870 schedule: type: recurring startTime: '2024-05-10T00:00:00+0000' pattern: type: monthly dayOfMonth: '1' timezone: Asia/Calcutta subject: Dashboard analysis report message: Dashboard analysis report recipients: - USR0000000045 format: - pdf - id: c4507c6f6-7a07-4416-8355-c933a4959035 name: Monthly Dashboard Analysis2 parameters: analysisPeriod: label: Last 24 hours variablesMap: Reports: storage1 Reports1: storage2 dashboardId: at4df71-8c1f-4791-9d53-0e00150b5488 createdBy: id: USR0000000022 lastName: QA firstName: opsramp loginName: opsrampqa schedules: - id: c513c6f6-7a07-4416-8355-c463a4959870 schedule: type: recurring startTime: '2024-05-10T00:00:00+0000' pattern: type: daily repeatFrequency: 1 timezone: Asia/Calcutta subject: Dashboard analysis report message: Dashboard analysis report recipients: - USR0000000045 format: - pdf totalPages: 1 totalResults: 2 descendingOrder: true nextPage: false orderBy: name pageNo: 1 pageSize: 100 previousPageNo: 0 description: |- Search dashboard analyses. tags: - dashboard-analyses '/reporting/api/v3/tenants/{tenantId}/dashboard-analyses/{analysisId}': summary: 'dashboard-analyses/{analysisId}' description: | Manage individual dashboard analysis. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/analysisId' get: summary: Get dashboard analysis details operationId: get-dashboard-analysis-details responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DashboardAnalysis' examples: dashboard-analysis-details: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" name: "Monthly Dashboard Analysis" parameters: analysisPeriod: label: "Last 24 hours" variablesMap: Reports: "storage1" Reports1: "storage2" dashboardId: "at4df71-8c1f-4791-9d53-0e00150b5488" createdBy: id: "USR0000000022" lastName: "QA" firstName: "opsramp" loginName: "opsrampqa" schedules: - id: "c513c6f6-7a07-4416-8355-c463a4959870" schedule: type: "recurring" startTime: "2024-05-10T00:00:00+0000" pattern: type: "monthly" dayOfMonth: "1" timezone: "Asia/Calcutta" subject: "Dashboard analysis report" message: "Dashboard analysis report" recipients: - "USR0000000045" format: - "pdf" description: |- Get details of dashboard analysis. tags: - dashboard-analyses put: summary: Update dashboard analysis operationId: put-dashboard-analysis requestBody: content: application/json: schema: type: object properties: name: type: string schedules: type: array items: type: object properties: schedule: $ref: '#/components/schemas/Schedule' subject: type: string message: type: string recipients: type: array items: type: string examples: update-analysis: value: name: "Monthly Dashboard Analysis" schedules: - schedule: type: "recurring" startTime: "2024-05-10T00:00:00+0000" pattern: type: "monthly" dayOfMonth: "1" timezone: "Asia/Calcutta" subject: "Dashboard analysis report" message: "Dashboard analysis report" recipients: - "USR0000000045" responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string examples: analysis-updated: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" description: |- Update dashboard analysis. tags: - dashboard-analyses delete: summary: Delete dashboard analysis operationId: delete-dashboard-analysis responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string examples: analysis-deleted: value: status: "Successfully deleted the dashboard analysis Monthly Dashboard Analysis" description: |- Delete dashboard analysis. tags: - dashboard-analyses '/reporting/api/v3/tenants/{tenantId}/dashboard-runs': summary: dashboard-runs description: | Manage dashboard runs for reporting. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' get: summary: Search dashboard runs operationId: get-dashboard-runs responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/DashboardRun' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: dashboard-runs-list: value: results: - id: b315c6f6-7a07-4416-8355-c933a4959320 parameters: analysisPeriod: Last 24 hours variablesMap: Reports: storage1 Reports1: storage2 dashboardId: at4df71-8c1f-4791-9d53-0e00150b5488 createdBy: id: USR0000000022 lastName: QA firstName: opsramp loginName: opsrampqa createdDate: '2024-05-09T15:11:43+0000' format: - pdf status: completed - id: b315c6f6-7a07-4416-8355-c933a4959320 parameters: analysisPeriod: Last 24 hours variablesMap: Reports: storage1 Reports1: storage2 dashboardId: at4df71-8c1f-4791-9d53-0e00150b5488 createdBy: id: USR0000000022 lastName: QA firstName: opsramp loginName: opsrampqa createdDate: '2024-05-09T15:11:43+0000' format: - pdf status: completed totalPages: 1 totalResults: 2 descendingOrder: true nextPage: false orderBy: id pageNo: 1 pageSize: 100 previousPageNo: 0 description: |- Search dashboard runs. tags: - dashboard-runs post: summary: Create dashboard run operationId: dashboard-runs-post requestBody: content: application/json: schema: type: object properties: dashboardId: type: string parameters: type: object properties: analysisPeriod: type: string variablesMap: type: object additionalProperties: type: string failureNotification: type: boolean subscribeMe: type: boolean recipients: type: array items: type: string dlRecipients: type: array items: type: string subject: type: string message: type: string analysisId: type: string format: type: array items: type: string required: - dashboardId examples: dashboard-run-create: value: dashboardId: "a2693b10-3b12-402c-b20b-e858ea76fdaa" parameters: analysisPeriod: "Last 30 Days" variablesMap: r1: "1" r2: "2" failureNotification: true subscribeMe: true recipients: - "USR0000000077" - "USR0000000078" dlRecipients: - "USRGRP-2ca73a34-301a-43e5-977e-6d8b88d37016" - "USRGRP-29c590f3-bd8a-4742-aa91-9fb316f596a8" subject: "Test subject" message: "Test message" dashboard-run-with-analysis: value: dashboardId: "at4df71-8c1f-4791-9d53-0e00150b5488" analysisId: "3114d076-9fce-402c-b7ad-0d963ea096b7" format: - "PDF" responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string examples: run-created: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" description: |- Create dashboard run. tags: - dashboard-runs '/reporting/api/v3/tenants/{tenantId}/dashboard-runs/{runId}': summary: 'dashboard-runs/{runId}' description: | Manage individual dashboard run. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/runId' get: summary: Get dashboard run details operationId: get-dashboard-run-details responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DashboardRun' examples: dashboard-run-details: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" parameters: analysisPeriod: "Last 24 hours" variablesMap: Reports: "storage1" Reports1: "storage2" dashboardId: "at4df71-8c1f-4791-9d53-0e00150b5488" createdBy: id: "USR0000000022" lastName: "QA" firstName: "opsramp" loginName: "opsrampqa" createdDate: "2024-05-09T15:11:43+0000" format: - "pdf" status: "completed" description: |- Get details of dashboard run. tags: - dashboard-runs put: summary: Update dashboard run operationId: put-dashboard-run requestBody: content: application/json: schema: type: object properties: runningPercentage: type: string status: type: string resultUrl: type: string pdfFilePath: type: string completedTime: type: string failureReason: type: string examples: update-progress: value: runningPercentage: "35" status: "inprogress" update-completed: value: resultUrl: "analytics-apps/report-builder/91a24ed7-6803-4b0c-94fb-787ec382de13/json/91a24ed7-6803-4b0c-94fb-787ec382de13" pdfFilePath: "analytics-apps/report-builder/91a24ed7-6803-4b0c-94fb-787ec382de13/xls/report-builder-91a24ed7-2024-05-30-06-03-08.pdf" completedTime: "2024-05-09T15:11:43+0000" status: "completed" update-failed: value: status: "failed" failureReason: "pdf generation issue" responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string examples: run-updated: value: id: "b315c6f6-7a07-4416-8355-c933a4959320" description: |- Update dashboard run. tags: - dashboard-runs '/reporting/api/v3/tenants/{tenantId}/dashboard-runs/{runId}/downloads': summary: 'dashboard-runs/{runId}/downloads' description: | Downloads dashboard run in the supported formats. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/runId' get: summary: Download dashboard run operationId: get-dashboard-run-download responses: '200': description: OK content: application/pdf: schema: type: string format: binary examples: example-download: value: binary format description: |- Downloads dashboard run. ### Example URL - {base_url}/reporting/api/v3/tenants/{tenantId}/dashboard-runs/{runId}/downloads?format=pdf - Downloads a given format at a time. - supported response headers. To be used based on the format chosen to download - application/pdf parameters: - schema: type: string enum: - pdf in: query name: format description: Supported format for dashboard downloads tags: - dashboard-runs '/reporting/api/v3/tenants/{tenantId}/dashboard-runs/{runId}/sends': summary: 'dashboard-runs/{runId}/sends' description: | Send dashboard run report. **Note**: When making API requests, ensure the following headers are included: - **Authorization**: Bearer UserToken (replace UserToken with your actual access token). For details on how to obtain the token, refer [Actions on a user](https://docs.opsramp.com/platform-features/feature-guides/account-management-1/users-and-permissions/users/user-portal/#actions-on-a-user) section. - **Content-Type**: application/json - **Accept**: application/json x-new-path: true x-internal: true parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/runId' post: summary: Send dashboard run report operationId: post-dashboard-run-send requestBody: content: application/json: schema: type: object examples: send-report: value: {} responses: '200': description: OK content: application/json: schema: type: object properties: send: type: string examples: send-success: value: send: "success" description: |- Send dashboard run report. tags: - dashboard-runs components: securitySchemes: accessToken: type: oauth2 flows: clientCredentials: tokenUrl: 'https://subdomain.api.opsramp.com' scopes: {} parameters: tenantId: in: path name: tenantId schema: type: string description: Describes partnerId or clientId of the tenant required: true appId: name: appId in: query schema: type: string description: Filter based on reporting appId runId: name: runId in: path required: true schema: type: string description: Describes run uuid of runs on the reporting app analysisId: name: analysisId in: path schema: type: string description: Describes analysis uuid of the analyses of the reporting app required: true scheduleId: name: scheduleId in: path required: true schema: type: string description: Describes schedule uuid of runs on the reporting app status: name: status in: query required: false schema: type: string enum: - pending - failed - running - completed example: running description: The current status of the run schemas: runs: description: Runs uuid type: object title: Runs properties: appId: type: string description: Reporting appId analysisId: type: string description: AnalysisId when run is associated with an analysis. parameters: type: object description: Parameters as defined in the reporting app manifest. format: type: array description: Supported output formats of the analysis. items: type: string enum: - pdf - xlsx example: pdf required: - appId - parameters analysis: description: '' type: object title: '' properties: name: type: string minLength: 1 description: Analysis name appId: type: string description: Installed reporting appId writeOnly: true parameters: type: object description: Parameters as defined in the reporting app manifest. required: - name - appId - parameters analysisDetails: description: '' type: object title: '' x-examples: {} properties: id: type: string description: Analysis uuid readOnly: true name: type: string minLength: 1 description: Analysis name tenantId: type: string appId: type: string description: Installed reporting appId writeOnly: true parameters: type: object description: Parameters as defined in the reporting app manifest. createdBy: type: object properties: id: type: string loginName: type: string lastName: type: string firstName: type: string updatedBy: type: object properties: id: type: string loginName: type: string lastName: type: string firstName: type: string createdDate: type: string description: Analysis created date required: - name - appId - parameters schedule: type: object description: '' title: '' properties: type: type: string enum: - recurring - onetime description: Type of schedule. One-time only or Recurring startTime: type: string description: Schedule Start Time. timezone: type: string description: Time-Zone selected for the schedule. pattern: type: object description: Recurring pattern properties: type: type: string enum: - weekly - monthly - daily description: Type of the repeated pattern. weekDays: type: string example: 'sunday,monday,tuesday,wednesday,thursday,friday,saturday' description: 'Day of the week, when the weekly pattern should repeat.e.g Weekly report on every Monday,Wednesday and Friday.' dayOfMonth: type: string description: Pattern to be repeated on given day of the month.To be used when the pattern type is "Monthly". e.g. Monthly repeat on every "Friday" and "Wednesday". repeatFrequency: type: string description: 'Frequency with which the pattern would repeat.Offset into month. 1=first day, 2=second day last=last day. Offsets 27, 28, 30, 31 are not allowed".' required: - type - startTime - timezone postQuery: type: object properties: fields: type: array items: type: string filterCriteria: type: string runDetails: type: object x-examples: {} description: '' properties: id: type: string description: Run uuid. appId: type: string description: Installed reporting appId. tenantId: type: string analysisId: type: string parameters: type: object createdBy: type: object properties: id: type: string loginName: type: string firstName: type: string lastName: type: string createdDate: type: string status: type: string description: The current status of the run. example: running enum: - pending - failed - running - completed format: type: array items: type: string completedTime: type: string description: The runs completed time. required: - appId scheduledAnalysis: type: object x-examples: {} properties: id: type: string description: Schedule uuid readOnly: true name: type: string description: Schedule name schedule: $ref: '#/components/schemas/schedule' recipients: type: array items: type: string format: type: array description: Supported output formats of the analysis. items: type: string message: type: string description: Notification message appId: type: string createdBy: type: string subject: type: string required: - schedule schedules: type: object x-examples: {} properties: name: type: string description: Schedule name analysisId: type: string description: Associated analysis uuid id: type: string description: Analysis uuid schedule: $ref: '#/components/schemas/schedule' recipients: type: array items: type: string format: type: array description: Supported output formats of the Reporting analysis. items: type: string message: type: string description: Notification message subject: type: string required: - name - analysisId - schedule - id reportingApp: title: reportingApp x-stoplight: id: vwylyywtyjuib type: object properties: appName: type: string displayName: type: string x-examples: {} installedApp: type: object properties: id: type: string appName: type: string displayName: type: string x-examples: {} Schedule: type: object properties: type: type: string enum: - recurring - onetime description: Type of schedule. One-time only or Recurring startTime: type: string description: Schedule Start Time. timezone: type: string description: Time-Zone selected for the schedule. pattern: type: object description: Recurring pattern properties: type: type: string enum: - weekly - monthly - daily description: Type of the repeated pattern. weekDays: type: string example: 'sunday,monday,tuesday,wednesday,thursday,friday,saturday' description: 'Day of the week, when the weekly pattern should repeat.' dayOfMonth: type: string description: Pattern to be repeated on given day of the month. repeatFrequency: type: string description: 'Frequency with which the pattern would repeat.' required: - type - startTime - timezone ScheduleWithNotification: allOf: - type: object properties: id: type: string schedule: $ref: '#/components/schemas/schedule' schedules: $ref: '#/components/schemas/schedules' subject: type: string message: type: string recipients: type: array items: type: string format: type: array items: type: string enum: - pdf - xlsx required: - schedule User: type: object properties: id: type: string loginName: type: string firstName: type: string lastName: type: string DashboardAnalysis: type: object properties: id: type: string description: Analysis uuid readOnly: true name: type: string description: Analysis name parameters: type: object properties: analysisPeriod: oneOf: - type: string - type: object properties: label: type: string variablesMap: type: object additionalProperties: type: string dashboardId: type: string createdBy: $ref: '#/components/schemas/User' schedules: type: array items: $ref: '#/components/schemas/schedules' required: - name - dashboardId - parameters DashboardRun: type: object properties: id: type: string description: Run uuid. parameters: type: object properties: analysisPeriod: type: string variablesMap: type: object additionalProperties: type: string dashboardId: type: string createdBy: $ref: '#/components/schemas/User' createdDate: type: string format: type: array items: type: string status: type: string description: The current status of the run. enum: - pending - failed - running - completed - inprogress runningPercentage: type: string resultUrl: type: string pdfFilePath: type: string completedTime: type: string failureReason: type: string required: - dashboardId responses: paginatedSprints: description: Example response content: application/json: schema: description: '' type: object properties: results: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/runs' totalResults: type: number pageNo: type: number pageSize: type: number totalPages: type: number sortOrder: type: string minLength: 1 sortBy: type: string minLength: 1 required: - results - totalResults - pageNo - pageSize - totalPages - sortOrder - sortBy examples: example-runs: value: results: - id: 7d8debe0-a714-4d44-9c94-9b367a47d18f parameters: param-1: param-1-value param-2: param-1-value appId: ALERT-LISTING status: pending - id: fbb4747a-044e-462b-9603-40dabd15957d appId: ALERT-LISTING parameters: param-1: param-1 param-2: param-2 status: pending - id: 8d4bf85d-903a-4a39-96f7-73b82dcc46e6 appId: ALERT-LISTING parameters: param-1: param-1 param-2: param-2 status: pending - id: 7d8debe0-a714-4d44-9c94-9b367a47d18f appId: ALERT-LISTING parameters: param-1: param-1 param-2: param-2 status: pending totalResults: 4 pageNo: 1 pageSize: 100 totalPages: 1 sortOrder: ascending sortBy: createdBy paginatedAnalysis: description: Example response content: application/json: schema: type: object x-examples: example-analysis-list: results: - id: 4b272b8c-d047-4f04-9661-a27801baaea8 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:03:42+0000' status: COMPLETED format: - pdf - xlsx completedTime: '2022-05-31T23:06:00+0600' - id: 32e1258c-471e-467e-aaaf-026b92825bce appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:05:47+0000' status: COMPLETED format: - pdf - xlsx completedTime: '2022-05-31T23:07:57+0600' - id: b0117b38-85c3-4982-aa5f-29f031f468b4 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:13:26+0000' status: COMPLETED format: - pdf - xlsx completedTime: '2022-05-31T23:15:59+0600' totalResults: 3 orderBy: createdDate pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true properties: results: type: array items: $ref: '#/components/schemas/analysisDetails' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-analysis-list: value: results: - id: 91d0ce11-0c1b-4661-bf4c-4e779ac4be8a name: Test-Analysis-1 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:05:21+0000' parameters: analysisPeriod: Last 24 Hours - id: bcee019a-7371-4fdd-854c-663853ab0ac2 name: Analysis-without-runid tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T02:06:54+0000' parameters: analysisPeriod: Last 24 Hours - id: c31f7246-0a97-4747-9324-2251ada0e78b name: Asset insights analysis tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-27T11:39:12+0000' parameters: analysisPeriod: Last 24 Hours - id: 147f572b-40c2-4dee-8814-3358024624a2 name: last 7 day - 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:22:07+0000' parameters: analysisPeriod: Last 24 Hours - id: fd8dcfed-3987-4ef9-8116-7af0118c44a0 name: last 7 days with pdf - 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:38:46+0000' parameters: analysisPeriod: Last 7 Days - id: a31bf8be-8bda-47ad-bfa3-b7fb4dd30fce name: Mereted usage insights run daily tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-26T07:31:52+0000' updatedDate: '2022-05-26T07:36:51+0000' parameters: analysisPeriod: Last 24 Hours - id: 7ff03daf-6285-44b5-b449-129353fbcb9d name: my asset insight analysis run daily tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-25T17:24:25+0000' updatedDate: '2022-05-25T17:33:09+0000' parameters: analysisPeriod: Snapshot - id: eaa46d05-78d2-4835-8f1e-6d9c5f19c58a name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T01:32:12+0000' updatedDate: '2022-06-06T01:32:31+0000' parameters: analysisPeriod: Last 24 Hours - id: 00e995be-e720-4748-99a5-45ac1a1eb010 name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T01:44:43+0000' updatedDate: '2022-06-06T01:46:18+0000' parameters: analysisPeriod: Last 24 Hours - id: 4a815e5c-83de-40a4-becc-973056f089ca name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T05:09:22+0000' parameters: analysisPeriod: Last 24 Hours - id: 53a37b85-9136-48ff-85b9-13eb7ad3bed7 name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T05:12:45+0000' parameters: analysisPeriod: Last 24 Hours - id: b37b12ad-a940-46a4-984a-ee1356f5224c name: My test analysis 17 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-18T18:11:14+0000' updatedDate: '2022-05-18T18:16:09+0000' parameters: analysisPeriod: Last 24 Hours - id: 5d69f97e-76ba-465c-9e77-9c5dfdafe491 name: Test 123 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-06-06T05:09:34+0000' updatedDate: '2022-06-06T05:11:10+0000' parameters: analysisPeriod: Last 24 Hours - id: 4c8efb49-3604-4a3b-9c74-16b62af99233 name: test2 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:19:37+0000' parameters: analysisPeriod: Last 24 Hours - id: 08cae2a6-614f-4cd3-bdc8-f44c15e3fa89 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:00:17+0000' parameters: analysisPeriod: Last 24 Hours - id: 253dffe4-27ed-48ed-91b0-61909596b770 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:02:16+0000' parameters: analysisPeriod: Last 24 Hours - id: 5f5b72ef-be89-44d3-99ca-009428cba558 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:02:55+0000' parameters: analysisPeriod: Last 24 Hours - id: e1f317b8-ce51-446b-a270-ec2fb1438df8 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:07:19+0000' parameters: analysisPeriod: Last 24 Hours - id: 04c4e748-258b-4150-bc83-0251d9edcce5 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:09:01+0000' updatedDate: '2022-06-06T08:10:51+0000' parameters: analysisPeriod: Last 24 Hours - id: f46321c4-6c95-4b73-8bed-2de0da38ff2c name: Today 24 May 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-24T06:41:12+0000' parameters: analysisPeriod: Last 24 Hours totalResults: 20 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true example-analysis-Installed-appId: value: results: - id: c31f7246-0a97-4747-9324-2251ada0e78b name: Asset insights analysis tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test createdDate: '2022-05-27T11:39:12+0000' parameters: analysisPeriod: Last 24 Hours - id: 7ff03daf-6285-44b5-b449-129353fbcb9d name: my asset insight analysis run daily tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test updatedBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test createdDate: '2022-05-25T17:24:25+0000' updatedDate: '2022-05-25T17:33:09+0000' parameters: analysisPeriod: Snapshot - id: b37b12ad-a940-46a4-984a-ee1356f5224c name: My test analysis 17 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test updatedBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test createdDate: '2022-05-18T18:11:14+0000' updatedDate: '2022-05-18T18:16:09+0000' parameters: analysisPeriod: Last 24 Hours - id: 5d69f97e-76ba-465c-9e77-9c5dfdafe491 name: Test 123 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test updatedBy: id: USR0002793588 loginName: test@tets.com firstName: vijay lastName: test createdDate: '2022-06-06T05:09:34+0000' updatedDate: '2022-06-06T05:11:10+0000' parameters: analysisPeriod: Last 24 Hours totalResults: 4 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true runs: description: Example response content: application/json: schema: $ref: '#/components/schemas/runDetails' examples: example-runs: value: id: b0117b38-85c3-4982-aa5f-29f031f468b4 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:13:26+0000' status: running format: - pdf - xlsx example-runs-with-analysisId: value: id: 8169463e-3573-4f14-9d13-379de9e4c203 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-07T01:44:35+0000' status: running format: - pdf - xlsx analysisId: dd837b44-9ca9-4b4a-84c3-679155a2dda3 analysis: description: Example response content: application/json: schema: $ref: '#/components/schemas/analysisDetails' examples: example-analysis: value: id: b5c2bebf-2784-4a86-96e2-0551243e79a5 name: updated-analysis tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:08:36+0000' parameters: analysisPeriod: Last 24 Hours schedules: description: Example response content: application/json: schema: $ref: '#/components/schemas/scheduledAnalysis' examples: example-schedule-weekly: value: id: a5e7bfb1-5984-4e86-16e2-0751243e79b5 tenantId: 615ca94e-e423-4efa-80c3-3c7d0dad15ee name: Scheduled-weekly analysisId: b5c2bebf-2784-4a86-96e2-0551243e79a5 schedule: type: recurring startTime: '2022-06-27T00:00:00+0000' pattern: type: weekly weekDays: 'sunday,monday,tuesday,wednesday,thursday,friday,saturday' timezone: Asia/kolkata subject: 'Subject : Asset Insights' message: Scheduled analysis for weekly format: - pdf - xlsx example-schedule-monthly: value: analysisId: fd4494a5-4812-4d5b-bf0f-ecc605f22cbb name: Monthly schedule schedule: type: recurring startTime: '2022-05-18T15:30:00+0000' pattern: type: monthly dayOfWeek: monday weekIndex: first timezone: America/Los_Angeles recipients: - USR0000000022 subject: 'Subject : Asset Insights' message: Asset-Insights app report mail format: - pdf - xlsx paginatedRuns: description: Example response content: application/json: schema: type: object x-examples: example-1: results: - id: string appId: string tenantId: string analysisId: string parameters: {} createdBy: id: string loginName: string firstName: string lastName: string createdDate: string status: string format: - string completedTime: string totalResults: 0 orderBy: string pageNo: 0 pageSize: 0 totalPages: 0 nextPage: true previousPageNo: 0 descendingOrder: true properties: results: type: array items: $ref: '#/components/schemas/runDetails' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-list-runs: value: results: - id: 4b272b8c-d047-4f04-9661-a27801baaea8 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:03:42+0000' status: completed format: - xlsx completedTime: '2022-05-31T23:06:00+0000' - id: 32e1258c-471e-467e-aaaf-026b92825bce appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:05:47+0000' status: completed format: - pdf - xlsx completedTime: '2022-05-31T23:07:57+0000' - id: b0117b38-85c3-4982-aa5f-29f031f468b4 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:13:26+0000' status: completed format: - pdf - xlsx completedTime: '2022-05-31T23:15:59+0000' - id: 2ba7d5da-e48d-477a-bb78-1819a65c5255 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T04:41:56+0000' status: completed format: - pdf - xlsx analysisId: 53a37b85-9136-48ff-85b9-13eb7ad3bed7 completedTime: '2022-06-01T10:44:12+0000' - id: fa392f9c-def7-4c22-bf48-5598cd14eaea appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T06:57:34+0000' status: completed format: - pdf - xlsx completedTime: '2022-06-01T12:59:46+0000' - id: 90305894-a1df-43fc-b187-92cabedfc4eb appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T01:30:48+0000' status: completed format: - pdf - xlsx analysisId: 00e995be-e720-4748-99a5-45ac1a1eb010 completedTime: '2022-06-06T07:33:12+0000' - id: 42ad3eef-384c-4720-afb0-0d7f36811207 appId: ALERT-LISTING tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb parameters: analysisPeriod: Last 24 Hours createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T02:15:47+0000' status: completed format: - pdf - xlsx completedTime: '2022-06-06T08:18:16+0000' totalResults: 7 orderBy: createdDate pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true runsId: description: Example response content: application/json: schema: type: object properties: id: type: string description: runsId of the runs. examples: example-runId: value: id: b5c2bebf-2784-4a86-96e2-0551243e79a5 analysisId: description: Example response content: application/json: schema: type: object properties: id: type: string description: analysisId of the analysis. examples: example-analysisId: value: id: aec07766-0a93-4bbe-8fa2-b36875323b20 schedulesId: description: Example response content: application/json: schema: type: object properties: id: type: string description: scheduleId of the schedules. examples: example-scheduleId: value: id: a5e7bfb1-5984-4e86-16e2-0751243e79b5 appId: description: Example response content: application/json: schema: type: object properties: id: type: string examples: example-reporting-apps: value: id: d9c76b95-fa6c-4061-aba5-f66f152083fa message: description: Example response content: application/json: schema: type: object properties: code: type: string message: type: string examples: example-uninstall-app: value: message: Delete successful paginatedApps: description: Example response content: application/json: schema: type: object x-examples: example-1: results: - id: 91d0ce11-0c1b-4661-bf4c-4e779ac4be8a name: Test-Analysis-1 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-05-31T17:05:21+0000' parameters: analysisPeriod: Last 24 Hours - id: bcee019a-7371-4fdd-854c-663853ab0ac2 name: Analysis-without-runid tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T02:06:54+0000' parameters: analysisPeriod: Last 24 Hours - id: c31f7246-0a97-4747-9324-2251ada0e78b name: Asset insights analysis tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-27T11:39:12+0000' parameters: analysisPeriod: Last 24 Hours - id: 147f572b-40c2-4dee-8814-3358024624a2 name: last 7 day - 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:22:07+0000' parameters: analysisPeriod: Last 24 Hours - id: fd8dcfed-3987-4ef9-8116-7af0118c44a0 name: last 7 days with pdf - 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:38:46+0000' parameters: analysisPeriod: Last 7 Days - id: a31bf8be-8bda-47ad-bfa3-b7fb4dd30fce name: Mereted usage insights run daily tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-26T07:31:52+0000' updatedDate: '2022-05-26T07:36:51+0000' parameters: analysisPeriod: Last 24 Hours - id: 7ff03daf-6285-44b5-b449-129353fbcb9d name: my asset insight analysis run daily tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-25T17:24:25+0000' updatedDate: '2022-05-25T17:33:09+0000' parameters: analysisPeriod: Snapshot - id: eaa46d05-78d2-4835-8f1e-6d9c5f19c58a name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T01:32:12+0000' updatedDate: '2022-06-06T01:32:31+0000' parameters: analysisPeriod: Last 24 Hours - id: 00e995be-e720-4748-99a5-45ac1a1eb010 name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T01:44:43+0000' updatedDate: '2022-06-06T01:46:18+0000' parameters: analysisPeriod: Last 24 Hours - id: 4a815e5c-83de-40a4-becc-973056f089ca name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T05:09:22+0000' parameters: analysisPeriod: Last 24 Hours - id: 53a37b85-9136-48ff-85b9-13eb7ad3bed7 name: My test Analyses12 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-01T05:12:45+0000' parameters: analysisPeriod: Last 24 Hours - id: b37b12ad-a940-46a4-984a-ee1356f5224c name: My test analysis 17 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-18T18:11:14+0000' updatedDate: '2022-05-18T18:16:09+0000' parameters: analysisPeriod: Last 24 Hours - id: 5d69f97e-76ba-465c-9e77-9c5dfdafe491 name: Test 123 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi updatedBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-06-06T05:09:34+0000' updatedDate: '2022-06-06T05:11:10+0000' parameters: analysisPeriod: Last 24 Hours - id: 4c8efb49-3604-4a3b-9c74-16b62af99233 name: test2 16 may 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000054973 loginName: Network firstName: Network lastName: opsramp createdDate: '2022-05-16T17:19:37+0000' parameters: analysisPeriod: Last 24 Hours - id: 08cae2a6-614f-4cd3-bdc8-f44c15e3fa89 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:00:17+0000' parameters: analysisPeriod: Last 24 Hours - id: 253dffe4-27ed-48ed-91b0-61909596b770 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:02:16+0000' parameters: analysisPeriod: Last 24 Hours - id: 5f5b72ef-be89-44d3-99ca-009428cba558 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:02:55+0000' parameters: analysisPeriod: Last 24 Hours - id: e1f317b8-ce51-446b-a270-ec2fb1438df8 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:07:19+0000' parameters: analysisPeriod: Last 24 Hours - id: 04c4e748-258b-4150-bc83-0251d9edcce5 name: this is name tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' updatedBy: id: USR0000000002 loginName: opsramp_api_user firstName: API User lastName: ' ' createdDate: '2022-06-06T08:09:01+0000' updatedDate: '2022-06-06T08:10:51+0000' parameters: analysisPeriod: Last 24 Hours - id: f46321c4-6c95-4b73-8bed-2de0da38ff2c name: Today 24 May 2022 tenantId: 3365d8bf-b1aa-c33f-add1-439738a9a7fb appId: ALERT-LISTING createdBy: id: USR0002793588 loginName: vijay@OpsRampGateway firstName: vijay lastName: gadi createdDate: '2022-05-24T06:41:12+0000' parameters: analysisPeriod: Last 24 Hours totalResults: 20 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true properties: results: type: array items: $ref: '#/components/schemas/installedApp' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-list-reporting-apps: value: results: - id: string appName: string displayName: string - id: string appName: string displayName: string - id: string appName: string displayName: string totalResults: 0 orderBy: string pageNo: 0 pageSize: 0 totalPages: 0 nextPage: true previousPageNo: 0 descendingOrder: true requestBodies: query: content: application/json: schema: $ref: '#/components/schemas/postQuery' examples: example-filter-analysis: value: fields: - id - parameters - status filterCriteria: state = 'pending' AND appId = 'ALERT-LISTING' update-analysis: content: application/json: schema: type: object x-examples: example-1: name: 'Updated name :: test Analysis' properties: name: type: string required: - name examples: example-update-analysis: value: name: 'Updated name :: test Analysis' update-schedules: content: application/json: schema: $ref: '#/components/schemas/scheduledAnalysis' examples: example-update-schedules: value: name: update-schedule schedule: type: recurring startTime: '2022-06-23T00:00:00+0000' pattern: type: weekly weekDays: 'sunday,monday,tuesday,wednesday,thursday,friday,saturday' timezone: Asia/kolkata message: Asset-Insights app mail subject: 'Subject : Asset Insights' format: - pdf - xlsx reportingApps: content: application/json: schema: $ref: '#/components/schemas/reportingApp' examples: example-reporting-app: value: appName: Metric Reporting App displayName: 'My Metric Analysis ' tags: - name: analytics description: Analytics - name: runs description: Runs