IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Retrieve All Reports

URL

GET https://<dpod hostname>/op/api/v2/reports/{{productView}}

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:
name:
description:
productView:
apiReference:
indexSets:
documentType:
jsonQuery:
schedule:
recipients:
adHocFilterTypes:
filtersParameters:
lastUpdateTimeInMillis:
lastUpdateUserName:
esHeadersDictionary:

Erroneous Response

{
    "resultCode": "SUCCESS",
    "resultMessage": "Reports retrieved successfully",
}

resultCode:
resultMessage:

  • No labels