Integration Dashboards

Integration Dashboards provide detailed insights into the API requests you send us, the responses you receive, and any errors that occur. These dashboards help you quickly evaluate your integration's performance and identify areas for improvement, aiming to increase your successful transactions. Access real-time data and optimize your payment processes effortlessly.

Within the dashboards, you have access to three main pages: Dashboard, API Logs, and Error Overview.

Key benefits

Boost successful transactions: analyze and refine your API requests and errors to boost transaction success rates.
Real-time monitoring: watch your integration's performance and see the effects of new releases as they happen.
Comprehensive overview: view the count of successful and failed API requests in a single, unified dashboard.
Error insights: quickly identify and address areas for improvement with a detailed error overview.

How to access Integration Dashboards

The dashboards are available in pre-production and production environments. They allow you to see the details of all merchant IDs linked to your account.

Log in to the Configuration Center of the chosen environment.
Select "Integration Dashboards" from the menu to have them opened in a new tab.

Dashboard page

This page displays API request graphs, offering a visual summary of your API interactions. You can view API requests over a selected period, including details of failed requests and their HTTP codes.

API request graphs

These graphs visually represent your API activity. For more details, click "View selection in API Logs." By default, the graphs show API logs from the last 15 minutes.

Integration dashboards overview screen

All API requests:

Displays all API requests (green for successful, red for failed).
Toggle between "Count" or "Percentage" views using the labels in the upper-left corner.

Failed API requests:

Displays failed requests by (e.g., 4xx, 5xx).
View in "Count" or "Percentage" mode.
Switch to detailed views for specific errors (e.g., 400, 402, 403 for 4xx).
Hide specific errors by clicking the eye icon next to the error type.

API Logs Page

The API Logs page features a table listing detailed information about each API request and response, including:

Timestamp
HTTP Method
API Endpoint
Response (HTTP response code)
Error (codes and messages, if any)
Duration (time between request and response)
Your merchant ID and company name as registered with us

Click on an API log entry to access the API Log Details screen, where you can view detailed information about that specific API call and its response.

API Logs page

API Log Details

View the specifics of an API request and response, including additional information such as duration, endpoint, and request details:

Timestamp
API Request (HTTP Method and API Endpoint)
Response (HTTP response code)
Your connect merchant ID and name
Public API Key used for the call
Duration (the time between API request and response)
Your identifiers (e.g., merchantReference)
Worldline identifiers
Server and client metadata
Request and response data (headers and body)

API Log details page

Error Overview

This page aggregates errors by API endpoint, providing a clear picture of where issues may be occurring. Detailed error information includes:

HTTP Method: Method used by the API request (e.g., GET, POST).
API Endpoint: The endpoint where the error occurred.
HTTP Status: HTTP response code (e.g., 404, 500).
Error: Error code and message (refer to our error codes documentation for more details).
Count: Number of times this error occurred in the selected period.
% of Errors: Percentage of this error type compared to the total errors in the same category.
% of Total: Percentage of this error type compared to all errors.

Changing the selected timestamp will update the Error Overview table and all values on the page accordingly.

Errors overview page

Filtering

On each page of the dashboards you can filter data by a specific period and apply advanced filters.

Filtering based on timestamp

Click on the timestamp field to filter data by time.
Select from pre-set options such as Today, Yesterday, or the Last 15 Minutes, or choose your own custom range.
This filter will apply to all graphs for the selected period.
The selected timestamp will remain consistent across all pages of the Integration Dashboards.

Applying timestamp filter

Advanced filtering

Click "Create Filter" in the top-right corner to apply advanced filters.
Select the desired filter from the list.
Choose your search criteria and click "Apply."
The applied filter will remain consistent across all pages of the Integration Dashboards.

Applying advanced filter

Available filter options

When you switch to another page within the Integration Dashboards, your applied timestamp and filters will remain active.

API Endpoint: Simplified endpoint without query strings.
API Key: Public API Key.
API Type: Type of API used (e.g., Server API, Client API).
Country Code (Billing): Customer billing address country code (e.g., US, TR, NL).
Client SDK: Filters by SDKs and versions used.
Client Session ID: Temporary API Key for client authentication.
Currency Code: Currency code of the transaction (e.g., TL, USD, EUR).
Dispute ID: Unique identifier for disputes.
Error ID: Unique reference for debugging.
Hosted Checkout ID: ID for checkout data retrieval.
HTTP Method: Supported HTTP methods (e.g., GET, POST).
HTTP Response Code: Indicates request outcomes (e.g., 2xx, 4xx, 5xx).
Idempotence Key: Used for same request attempts.
Merchant Customer ID: Identifier assigned by you to your customers.
Merchant ID: Connect merchantId used in the API request.
Merchant Name: Your legal merchant name.
Merchant Order ID: Your order identifier.
Merchant Reference: Your unique transaction identifier.
Payment ID: Unique identifier for each payment.
Refund ID: Unique refund transaction identifier.
Server SDK: Filters by SDKs and versions used.
Token: Token identifier generated by Worldline.