Reports REST API

Get / Update / Execute / Delete reports

Authentication: Basic authentication

Authorization: Any user allowed using Reports, see:

curl -u username:password https://<dpod hostname>/op/api/v2/reports/{{productView}}

Retrieve All Reports
URL	`GET` https://<dpod hostname>/op/api/v2/reports/{{productView}}
Authorization (more info Role Based Access Control)	View or edit permissions for reports Access permission for the requested product view
URL Parameters	productView: IDG / APIC
Successful Response	{ "resultCode": "SUCCESS", "resultMessage": "Reports retrieved successfully", "result": { "reports": [{ "name": "API Latency Report", "description": "API Latency", "productView": "APIC", "apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856", "indexSets": "apic-log", "documentType": "APIC_LOGICAL_TRANS", "jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}}, ...", "schedule": "", "recipients": [], "adHocFilterTypes": [ "TIME", "DEVICE", "DOMAIN", "APIC_CATALOG", "APIC_SPACE", "APIC_PRODUCT", "APIC_PLAN", "APIC_API", "APIC_API_VERSION", "APIC_CONSUMER_APP" ], "filtersParameters": { "timeRangeType": "recent", "timeRangePeriod": "86400000" }, "lastUpdateTimeInMillis": 1646655197926, "lastUpdateUserName": "admin", "esHeadersDictionary": "" } ] } } resultCode: resultMessage: results: list of reports Reports REST API - Message Structure → Response Report

GET Retrieve All Reports

/op/api/v2/reports/{{productView}}

URL:

GET - https://`{{dpodHostname}}`/op/api/v2/reports/`{{productView}}`

Parameters:

Parameter	Value	Description	Parameter Type	Data Type
productView	required	Product view APIC / IDG	path	APIC / IDG

Authorization:

Authentication Type	Required Permissions	More info
Basic Auth	View or Edit report Access permissions for required product	See roles information here: Role Based Access Control

Response:

Response Type

Value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "Reports retrieved successfully",
    "result": {
        "reports": [{
                "name": "API Latency Report",
                "description": "API Latency",
                "productView": "APIC",
                "apiReference": "1B1925B3-EAE0-4E4A-97B6-78AD13EDE856",
                "indexSets": "apic-log",
                "documentType": "APIC_LOGICAL_TRANS",
                "jsonQuery": "{\"query\":{\"bool\":{\"must\":{\"match_all\":{}},... }",
                "schedule": "",
                "recipients": [],
                "adHocFilterTypes": ["TIME", "DEVICE",....],
                "filtersParameters": { "timeRangeType": "recent",.....},
                "lastUpdateTimeInMillis": 1646655197926,
                "lastUpdateUserName": "admin",
                "esHeadersDictionary": ""
            }
        ]
    }
}

resultCode → SUCCESS

resultMessage → “Reports retrived successfully”

result → list of all reports and their data, for report parameter info click here click here: Reports REST API - Message Structure

IBM DataPower Operations Dashboard v1.0.20.x