API Logs
API logs are crucial for understanding the behavior, performance, and health of your applications.
Here, we guide you through how Uniblock provides detailed logging and how you can access and interpret these logs for optimal API performance.
Why API Logs Matter? 🧐
API logs offer visibility into the operation of your application. By analyzing API logs, you can:
- Identify and diagnose issues.
- Monitor API health and performance.
- Track user activity and patterns.
- Ensure security by detecting malicious activities.
![API Logs Table near the bottom of the Analytics Tab in the Dashboard](https://files.readme.io/05fcf98-Screenshot_2023-10-13_at_10.25.47_AM.png)
API Logs Table near the bottom of the Analytics Tab in the Dashboard
Reading the Logs 📖
Each log entry provides detailed information:
- Timestamp: When the API call was made.
- Endpoint: Which API endpoint was accessed.
- Status: Success or error status.
- Response: The provider(s) that made the API call.
- Response Time: How long the API took to respond.
- IP Address: The IP from where the call originated.
- User-Agent: Information about the client making the request.
![Example of token/Metadata Detailed Request Log](https://files.readme.io/6f8ed34-Screenshot_2023-10-13_at_10.18.26_AM.png)
Example of token/Metadata Detailed Request Log
Detailed API Request Logs 📝
Clicking into a log entry provides in-depth log information for each API request to provide a transparent view into the interactions between your application and our system. Here's a breakdown of the key components in our detailed logs:
-
HTTP Method: Such as
GET
, indicating the type of request made. -
Endpoint Name: A brief descriptor like
TokenMetadata
offering context on the purpose of the request. -
Endpoint Path: The specific path like
/v1/token/metadata
accessed on our servers. -
Timestamp: The exact time when the request was made.
-
Response Time: Duration taken by our server to process and respond to the request.
-
Headers: These are meta-data associated with the request. It includes various fields like:
Host
: The domain making the request.User-Agent
: Information about the client system and browser.Accept
: The type of content expected in response.- ... and many others.
-
Query Parameters: These are additional data sent with the request to provide context or specify a certain behavior.
-
Request Body: The actual data sent in a
POST
orPUT
request. -
Response Headers & Body: Meta-data and actual data returned from our provider(s) in response to the request. There may be multiple in the case that priority list gets engaged.
![Example Response Body for token/Metadata with Moralis.](https://files.readme.io/9a128c0-Screenshot_2023-10-13_at_10.19.55_AM.png)
Example Response Body for token/Metadata with Moralis.
By diving deep into these logs, developers can quickly troubleshoot, optimize, and secure their application's interactions with Uniblock.
Filtering and Searching 🔍
Use the filter options to narrow down logs based on specific criteria, such as providers, status codes, endpoints, or time frames. The search bar allows you to quickly find logs containing specific keywords or error messages.
Log Retention Policy 📅
Uniblock retains API logs for 90 days. If you require extended retention or need to access logs older than 90 days, please reach out to our support team.
Updated 3 months ago