API Request log
Opening the item
Follow the steps below to access an API request:
Navigate to the Admin Panel
Click Administration on the left sidebar
Go to the Api Request log menu item.
Click Show in a request line to open its details.
Component parameters
Parameter | Description |
---|---|
Way | Defines whether the request is incoming (green) or outgoing (yellow). |
Requested At | Date and time of request creation. |
Initiator | Request initiator details, such as API keys. |
Uri | Uniform Resource Identifier is a unique sequence of characters that identifies the resource of a request. |
Method | Defines the method used in a request. |
User Agent | Defines a webhook service used to generate a request. |
Request Size | Defines the amount of data in the request. |
Response Size | Defines the amount of data in the response. |
Code | Response code. |
IP | Request’s IP address. |
Action | Click Show to open request details without the ability to edit them. |
Filters |
|
Configuring the component
Parameter | Description |
---|---|
Way | Defines whether the request is incoming (green) or outgoing (yellow). |
Initiator | Request initiator details, such as API keys. |
Affected Objects | If the request affects any object in the system—for example, personal details of a client—the Change Log List button is shown that allows to open Client Activity logs with the full list of affected objects. |
Initiator Id | Defines a unique sequence of characters that identifies the request Initiator. |
Uri | Uniform Resource Identifier is a unique sequence of characters that identifies the resource of a request. |
Method | Defines the method used in a request. |
User Agent | Defines a webhook service used to generate a request. |
Code | Response code. |
IP | Request’s IP address. |
Request Size | Defines the amount of data in the request. |
Response Size | Defines the amount of data in the response. |
Requested At | Date and time of request creation. |
Responded At | Date and time of response creation. |
Bodies | Request and Response bodies. |