The following shows how to generate the prolexic-liveness-checks-internal-kpi-summary report using either the Reporting API's Generate a report POST operation or the Get a cacheable report GET operation. Details about each report's supported products, metrics, filters, and available data intervals are also available dynamically by running the API's Get a report type operation, also shown below. See also other available reports.

Report definition

Provides a summary of network liveness check KPIs for target IP addresses. Default report time interval is FIVE_MINUTES.

Business object: targetIps

Data available for: 90 days

Required products: Prolexic Routed, Prolexic over ADC, Prolexic Connect, or IP Protect

Available filters

Filter	Type	Description
`targetIps`	Array of strings	The target IP addresses to filter by
`regions`	Array of strings	OptionalThe region to filter by: `EMEA`, `AMERICAS` or `APAC` When this filter is present in the request body, the region suffix (eg. “... - APAC”, “... - EMEA”) is omitted from the `target`response data.
`scrubbing-centers`	Array of strings	Optional scrubbing centers to filter by. If you are also using the `regions` filter, you must select scrubbing centers within the same region. For a list of scrubbing centers, use List active scrubbing centers in the Prolexic Analytics API.

Available KPI data: also available as summary statistics

Data column	Description
`probeSuccessRate`	The probe's success rate as a percentage
`targetTotalCount`	The total count of targets probed
`probeCount`	The total number of target probes sent
`targetUnhealthyCount`	The number of probes returned unhealthy
`targetHealthyCount`	The number of probes returned healthy
`responseTimeMsAvg`	The average probe response time in milliseconds
`targetLastCheckedDurationMinutes`	The duration of the last target check in minutes.
`responseTimeMsMax`	The maximum probe response time in milliseconds
`responseTimeMsMin`	The minimum probe response time in milliseconds

POST request

POST /reporting-api/v1/reports/prolexic-liveness-checks-internal-kpi-summary/versions/5.1/report-data{?start,end,interval}

Sample:

/reporting-reports-executor-api/v1/reports/prolexic-liveness-checks-internal-kpi-summary/versions/5.1/report-data?start=2025-11-14T13%3A00%3A00Z&end=2025-11-21T14%3A00%3A00Z

Query parameters

Parameter	Type	Sample	Description
`start`	String	`2025-05-01T00:00:00Z`	Specifies the start of the reported period as an ISO-8601 timestamp with optional time zone. The report includes data that matches the start value's timestamp. REQUIRED
`end`	String	`2025-06-01T00:00:00Z`	Specifies the end of the reported period as an ISO-8601 timestamp with optional time zone. The report excludes any data that matches the end value's timestamp. REQUIRED

JSON request members

Member	Type	Description
`objectType`	String	The business object for the report.
`filters`	Object	Specifies a set of custom filters, with each filter's name keying an array with each filter's set of values: `targetIps`

Request body without optional filters

{
  "objectType": "targetIps",
  "objectIds": [
    "all"
  ],
  "filters": {
    "targetIps": [
      "192.168.1.1",
 			"192.168.1.2",
 			"192.168.1.3",
 			"192.168.1.4",
 			"192.168.1.5"
    ]
  }
}

Request body with `regions` filter

{
  "objectType": "targetIps",
  "objectIds": [
    "all"
  ],
  "filters": {
    “regions”: [ “EMEA” ],
    "targetIps": [
      "192.168.1.1",
 "192.168.1.2",
 "192.168.1.3",
 "192.168.1.4",
 "192.168.1.5"
    ]
  }
}

Request body with `scrubbing-centers` filter

{
  "objectType": "targetIps",
  "objectIds": [
    "all"
  ],
  "filters": {
    “scrubbing-centers”: [ “LON5”, “LON6” ],
    "targetIps": [
      "192.168.1.1",
 "192.168.1.2",
 "192.168.1.3",
 "192.168.1.4",
 "192.168.1.5"
    ]
  }
}

JSON responses

Status 200 application/json

Response body (the response is the same with or without the optional filters)

{
    "metadata": {
        "name": "prolexic-liveness-checks-internal-kpi-summary",
        "version": "4",
        "outputType": "FLAT",
        "groupBy": [],
        "interval": "FIVE_MINUTES",
        "start": "2025-11-14T13:00:00Z",
        "end": "2025-11-21T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 0,
        "filters": [
            {
                "name": "targetIps",
                "values": [
                    "all"
                ]
            }
        ],
        "columns": [],
        "objectType": "targetIPs",
        "objectIds": [
            "192.168.1.1",
            "192.168.1.2",
            "192.168.1.3",
            "192.168.1.5",
            "192.168.1.4"
        ]
    },
    "data": [],
    "summaryStatistics": {
        "probeSuccessRate": {
            "value": "90.2",
            "details": {}
        },
        "targetTotalCount": {
            "value": "5",
            "details": {}
        },
        "probeCount": {
            "value": "50645",
            "details": {}
        },
        "targetUnhealthyCount": {
            "value": "3",
            "details": {}
        },
        "targetHealthyCount": {
            "value": "2",
            "details": {}
        },
        "responseTimeMsAvg": {
            "value": "5077.0",
            "details": {}
        },
        "responseTimeMsMax": {
            "value": "9999.0",
            "details": {}
        },
        "responseTimeMsMin": {
            "value": "100.0",
            "details": {}
        }
    }
}