POST api/v1/apiCallList

Retrieve the list of api calls made.

Request Information

URI Parameters

None.

Body Parameters

APICallParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
DateFrom

List api calls made on and since YYYYMMDD. If supplied empty then todays calls will be returned

 string

None.
DateTo

List api calls made on and before YYYYMMDD. If supplied empty then todays calls will be returned

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "DateFrom": "sample string 1",
  "DateTo": "sample string 2",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<APICallParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateFrom>sample string 1</DateFrom>
  <DateTo>sample string 2</DateTo>
  <apiKey>sample string 1</apiKey>
</APICallParams>

Response Information

Resource Description

Returns:
200 OK Returns a list of api calls as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if there are no matching records in Caliq
503 Service Unavailable

apiCalls
NameDescriptionTypeAdditional information
apiCallList

Collection of apiCall

None.

Response Formats

application/json, text/json

Sample: 
{
  "apiCallList": [
    {
      "Date": "2025-01-15T04:52:08.0758903+00:00",
      "EndPoint": "sample string 2",
      "ExtraData": "sample string 3",
      "CallCount": 4
    },
    {
      "Date": "2025-01-15T04:52:08.0758903+00:00",
      "EndPoint": "sample string 2",
      "ExtraData": "sample string 3",
      "CallCount": 4
    }
  ]
}

application/xml, text/xml

Sample: 
<apiCalls xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiCall>
    <Date>2025-01-15T04:52:08.0758903+00:00</Date>
    <EndPoint>sample string 2</EndPoint>
    <ExtraData>sample string 3</ExtraData>
    <CallCount>4</CallCount>
  </apiCall>
  <apiCall>
    <Date>2025-01-15T04:52:08.0758903+00:00</Date>
    <EndPoint>sample string 2</EndPoint>
    <ExtraData>sample string 3</ExtraData>
    <CallCount>4</CallCount>
  </apiCall>
</apiCalls>