GET api/v1/log

Provides a detailed list of API calls made by a given API Key. The list will contain the most recent 1,000 calls, ordered by most recent to oldest.

Request Information

Headers

In order to receive live data, you must provide the necessary information to authenticate. This will require an API-Key, which is to be provided within the request header for every request. If an API-Key is not provided, sandbox data will be returned.

Name Description Type Additional Information
API-Key 32 Character GUID key String Required to return live information. If not provided, sandbox data will be returned.

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

API Request Logs

Collection of V1_Log
NameDescriptionTypeAdditional information
API_Key

The API Key used to create an API request

string

None.

Endpoint

The requested API Endpoint

string

None.

Request_Method

The API request method

string

None.

Request_AcceptType

The API request data accept type

string

None.

HTTP_Response_Code

The resulting HTTP Response Code of the call

integer

None.

Request_IP

The API request source IP Address

string

None.

Request_Timestamp

The Request Timestamp for the API call. The timestamp will be in UTC

date

None.

Is_Billable

Boolean determination if the API call is billable

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "API_Key": "sample string 1",
    "Endpoint": "sample string 2",
    "Request_Method": "sample string 3",
    "Request_AcceptType": "sample string 4",
    "HTTP_Response_Code": 5,
    "Request_IP": "sample string 6",
    "Request_Timestamp": "2020-07-06T06:53:17.1824433-05:00",
    "Is_Billable": true
  },
  {
    "API_Key": "sample string 1",
    "Endpoint": "sample string 2",
    "Request_Method": "sample string 3",
    "Request_AcceptType": "sample string 4",
    "HTTP_Response_Code": 5,
    "Request_IP": "sample string 6",
    "Request_Timestamp": "2020-07-06T06:53:17.1824433-05:00",
    "Is_Billable": true
  }
]

text/html

Sample:
[{"API_Key":"sample string 1","Endpoint":"sample string 2","Request_Method":"sample string 3","Request_AcceptType":"sample string 4","HTTP_Response_Code":5,"Request_IP":"sample string 6","Request_Timestamp":"2020-07-06T06:53:17.1824433-05:00","Is_Billable":true},{"API_Key":"sample string 1","Endpoint":"sample string 2","Request_Method":"sample string 3","Request_AcceptType":"sample string 4","HTTP_Response_Code":5,"Request_IP":"sample string 6","Request_Timestamp":"2020-07-06T06:53:17.1824433-05:00","Is_Billable":true}]

application/xml, text/xml

Sample:
<ArrayOfV1_Log xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Log.V1">
  <V1_Log>
    <API_Key>sample string 1</API_Key>
    <Endpoint>sample string 2</Endpoint>
    <HTTP_Response_Code>5</HTTP_Response_Code>
    <Is_Billable>true</Is_Billable>
    <Request_AcceptType>sample string 4</Request_AcceptType>
    <Request_IP>sample string 6</Request_IP>
    <Request_Method>sample string 3</Request_Method>
    <Request_Timestamp>2020-07-06T06:53:17.1824433-05:00</Request_Timestamp>
  </V1_Log>
  <V1_Log>
    <API_Key>sample string 1</API_Key>
    <Endpoint>sample string 2</Endpoint>
    <HTTP_Response_Code>5</HTTP_Response_Code>
    <Is_Billable>true</Is_Billable>
    <Request_AcceptType>sample string 4</Request_AcceptType>
    <Request_IP>sample string 6</Request_IP>
    <Request_Method>sample string 3</Request_Method>
    <Request_Timestamp>2020-07-06T06:53:17.1824433-05:00</Request_Timestamp>
  </V1_Log>
</ArrayOfV1_Log>