Table of Contents | ||
---|---|---|
|
Get System Gadget ID
Dashboard key
Dashboards | Dashboard Key |
---|---|
My Dashboard | mydashboard |
Requirement Report | requirement |
Test Case Report | testcase |
Issue Analysis Report | issueanalysis |
Issue Trends Report | issuetrends |
Top Issues Report | topissues |
Execution Summary Report | execution-summary |
Approval Workflow Report | approval-workflow |
Login Report | login |
Reusability Report | reusability |
Audit Log Report | auditlog |
Get System Gadget ID
API | https://<QMetry URL>/rest/analytics/latest/dashboards/<dashboard key>?isSystem=true Refer the above table to get dashboard key of the dashboard you want to export |
---|---|
Method | GET |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> |
Request Body | (empty) |
Response | Code : 200 |
Response success
Code : 400 |
Response failure
|
Export System Gadget without filters
API | https://<QMetry base URL>/rest/analytics/latest/gadget/export | Comments |
---|---|---|
Method | POST | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | { | Ggadget ID to be retrieved from api - |
Response | Code : 200 |
Response success
Code : 400 |
Response failure
| This requestId to be used in API- |
Check progress and get download link for exported report data |
Export System Gadget with filters
API | https://<QMetry base url>/rest/analytics/latest/gadget/export | Comments |
---|---|---|
Method | POST | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | { | gadget ID to be retrieved from API - |
Response | Code : 200 |
Response success
Code : 400 |
Response failure
| This requestID can be used in APIs |
Check progress and get download link for exported report data |
Get Dashboard Key for QMetry Custom Dashboards > My Dashboards
API | https://<QMetry Base URL>/rest/analytics/latest/dashboards/custom/search | |
---|---|---|
Method | POST | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | Request
|
title | Request |
---|
| |
Response |
Response success - Code : 200
|
Response failure - Code : 400
|
Get Dashboard Key for QMetry Custom Dashboards > Shared Dashboards
API | https://<QMetry Base URL>/rest/analytics/latest/dashboards/sharedWithUser | |
---|---|---|
Method | POST | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | Request
|
| ||
Response |
Response success - Code : 200
|
Response failure - Code : 400
|
Get Custom Gadget ID
API | https://<QMetry Base URL>/rest/analytics/latest/dashboards/{{dashboard key}}?isSystem=false Get dashboard key using |
---|
Method | GET |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report needs to be exported> |
Request Body | (empty) |
Response |
Response success - code 200
|
Response failure - code 400
|
Export Custom Gadget with filter
API | https://<QMetry Base URL>/rest/analytics/latest/gadget/export |
---|---|
Method | POST |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> |
Request Body | { |
Response |
Reponse success
|
Response failure
|
Export a Custom Gadget without a Filter
API | https://<QMetry Base URL>/rest/analytics/latest/gadget/export | Comment |
---|---|---|
Method | POST | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | { | Gadget ID to be retrieved from API - |
Response |
Response success - code 200
|
Response failure - code 400
|
Check progress and get download link for exported report data
API | https://<QMetry Base URL>/rest/analytics/latest/exports/{{request ID}}/progress Request ID should be retrieved from API to Export System Gadget with filter | Comments |
---|---|---|
Method | GET | |
Request Header | apiKey : <Your Open API key> Content-Type : <application/json> project : <Project key for which the report to be exported> | |
Request Body | (empty) | gadget ID to be retrieved from API - |
Response | Code : 200 |
Response success
|
Response success
Code : 400 |
Response failure
|
Response success
|