What Can I See in the API Details View?

The API Details View provides an in-depth look at the internal API exchanges between Paytia's telephony and API services. This feature is designed for troubleshooting and offers transparency into the data passed internally within the Paytia platform.

---

Purpose of the API Details View

• Troubleshooting: Helps diagnose and resolve issues related to telephony and API integration.
• Transparency: Displays the flow of data processed within Paytia services.
• Advanced Reporting: Offers detailed information about internal API processes associated with call records.

---

How to Access the API Details View

1. Ensure You Have the Advanced Log License

   • The API Details View is part of the Paytia Advanced Log License, which includes access to Call Records.
   • Verify your account has this license enabled.

2. Navigate to Call Records

   • In the Log Information menu, click on Call Records to open the call log history page.
   • You will see a list of call logs with action buttons.

   

3. Click the API Details Button

   • Locate the API Details button under the action column.
   • Clicking this button opens the API process flow information for the selected call.

   

---

What Information Does the API Details View Provide?

When accessing the API Details View, you can see a detailed table of internal API transactions. Each row in the table contains the following columns:

Column Header	Description
URI	The API endpoint that was accessed.
Method	The HTTP method used (e.g., POST).
Request Params	The parameters sent in the API request.
Response	The data Paytia returned in response to the request.
Actual Response	The processed result or status of the API interaction.
Time	The exact time the API call occurred.

---

Example Data View

In the API details table, you can review:

• Specific data passed between Paytia services.

• The API response for each request, including success or failure status.

• Time-stamped logs for precise tracking and analysis.

  

---

Use Case for API Details View

• Debugging Call Issues: Understand why a specific call or transaction may not have completed successfully.
• Validating API Data: Ensure that API requests and responses align with expected formats and requirements.
• Compliance and Reporting: Keep detailed records of API transactions for audits or troubleshooting purposes.

---

Additional Resources

For further details, refer to the Call Records article for a complete guide to navigating and using call history logs. If you encounter issues, contact Paytia Support
for assistance.