APapicontext

Get the Combined Pass/Fail Stats for an API Call for a Time Range

Use this API to get the pass/fail stats for a specific range of dates.

get/calls/{id}/stats/passfail_total

Request

Path parameters

idstring required

ID of API Call you want Stats for

Query parameters

location_idstring

Location where the API Call was made.

startstring date required

Start date for the time range - must be in ISO 8601 date format e.g. 2024-05-01

endstring date required

End date for the time range - must be in ISO 8601 date format e.g. 2024-05-01

Response

200

Example response

{
  "meta": {
    "call_id": "agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDxwgM",
    "max_time": "2021-03-11T12:00:00Z",
    "min_time": "2021-03-11T00:00:00Z",
    "location_id": "__ALL__",
    "name": "API test name"
  },
  "stat": {
    "total": 567,
    "PASS": {
      "total": 124,
      "COMPLETE": 124
    },
    "WARNING": {
      "HTTP_CLIENT_ERROR": 15,
      "total": 15
    },
    "FAIL": {
      "total": 428,
      "CONNECTION_ERROR": 428
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.