APapicontext

Get Stats for an API Call for a Specific Time Period

Use this API to get the latency stats for an hour, day, week or month.

get/calls/{id}/stats/

Request

Path parameters

idstring required

ID of API Call you want Stats for

Query parameters

kindstring required

Granularity of data desired. Either: DAY, WEEK, MONTH, YEAR.

timestring date required

Start time for specified period - must be in ISO 8601 date format e.g. 2024-05-01T15:00

typestring required

Return Stats for all calls in the specified period which had this result

location_idstring

Location ID of test agent that made the request

Response

200

Example response

{
  "meta": {
    "kind": "MONTH",
    "call_id": "agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDxwgM",
    "type": "ALL",
    "time": "2015-10-01T00:00:00Z",
    "name": "API test name"
  },
  "stat": {
    "avg_latency": 383.5,
    "max_latency": 749,
    "time": "2015-10-01T00:00:00Z",
    "count": 20
  }
}

Changes

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