JUSPAY Unified Dashboard

API Requests Analytics

Overview

The API Requests Analytics module provides comprehensive insights and monitoring capabilities for all API request data processed through the Juspay platform. It offers real-time and historical analysis of API performance, success rates, latency patterns, error distributions, and detailed breakdowns across various technical dimensions with specialized spike analysis for proactive issue detection.

This module is designed for a wide range of users, including:

  • Operations Teams: For monitoring API performance and identifying bottlenecks across different gateways and endpoints.

  • DevOps Engineers: To track API latency patterns, error rates, and system performance optimization.

  • API Developers: For investigating specific API issues, analyzing request patterns, and optimizing API response times.

  • Technical Support: To troubleshoot API-related issues and provide accurate status updates to internal teams and customers.

Accessing the Module

  1. Log in to the Juspay dashboard.

  2. From the main navigation menu on the left, click on Analytics.

  3. Select API Requests Analytics from the Analytics submenu.

  4. The navigation URL for this module is https://portal.juspay.in/analytics-apirequestslink icon.

API Requests Analysis
API Requests Analysis

Dashboard Overview

Key Performance Metrics

The dashboard displays essential API performance indicators at the top:

Core API Metrics:

  • API Availability Rate: Percentage of successful API requests (non-5xx responses) out of total requests initiated

  • Incoming Volume: Total number of API requests processed during the selected time period

  • 5xx Error Rate: Percentage of server errors (HTTP 5xx responses) indicating system issues

  • Average Latency: Mean response time for API requests, measured in milliseconds

Detailed Performance Indicators:

  • 2xx Volume: Number of successful API requests (HTTP 2xx responses)

  • 4xx Volume: Number of client error requests (HTTP 4xx responses)

  • 5xx Volume: Number of server error requests (HTTP 5xx responses)

  • Non-5xx Volume: Number of non-server error requests (all except 5xx responses)

  • Status Code Rates: Percentage breakdown of 2xx, 4xx, and 5xx response rates

  • Latency Percentiles: TP50 (median), TP95, and TP99 response times for performance analysis

Time Range Selection

  1. Use the date picker to select your desired time range for analysis.

  2. The system automatically rounds times to 5-minute intervals for consistency and performance.

  3. Choose from predefined ranges or set custom date ranges.

  4. Click Apply to refresh all metrics and charts with the new time range.

  5. Start Date Restriction: Configurable filter start date from "apiRequestsFilterStartDate" setting.

API Requests Analysis
API Requests Analysis

Spike Analysis Overview

Spike Analysis is a specialized feature that automatically detects unusual patterns in API performance:

  • Latency Spikes: Identifies periods when API response times significantly exceed normal patterns

  • 5xx Error Spikes: Detects increases in server error rates that may indicate system issues

  • Root Cause Analysis: Provides detailed investigation tools to identify the source of performance issues

  • Time Restrictions: Latency spike analysis is limited to maximum 1-hour intervals for accuracy

Filtering and Segmentation

Fixed Filters (Always Available)

Date Filter

  • Purpose: Select time range for API analysis

  • Options: Predefined ranges (Today, Last 7 days, Last 30 days, etc.) or custom date selection

  • Time Rounding: Automatic rounding to 5-minute intervals for performance

  • Start Date Restriction: Configurable filter start date from "apiRequestsFilterStartDate" setting

Sync Filter (Manual Refresh)

  • Purpose: Manual data synchronization

  • Usage: Click to refresh all dashboard data manually

  • When to Use: When you need the most current data or suspect data staleness

  • Visual Feedback: Loading indicators show refresh progress

API Requests Analysis
API Requests Analysis

Dynamic Segments

Dynamic segments provide powerful filtering capabilities for API request analysis:

Segment Characteristics

  • API-Driven: Segments are fetched from analytics endpoints based on data availability

  • Searchable: Use search functionality to quickly find specific segments

  • Single Selection: Limited to 1 segment selection at a time (unlike other analytics modules)

  • Real-time Updates: Segments automatically update dashboard data when applied

Available API Segments

  • merchant_id: Unique identifier for the merchant account processing API requests

  • x_merchant_id: Extended merchant identifier for cross-merchant analysis

  • status_code: HTTP status codes (200, 400, 404, 500, etc.) for response analysis

  • path: API request paths (/payments, /orders, /refunds, etc.) for endpoint-specific analysis

  • entity: API entity types for categorizing different API operations

  • version: API version information for tracking version-specific performance

  • gateway: Payment gateway information for gateway-specific analysis

  • action: API action types (create, update, delete, etc.) for operation analysis

  • network: Network information for connectivity analysis

  • res_err_code: Response error codes for detailed error categorization

  • req_type: Request type classification for analyzing different request patterns

  • parent_api_tag: Parent API tag information for hierarchical API analysis

Applying Segments

  1. Click on the "Add Segments" button to open the segment selection panel.

  2. Search for specific segments using the search input with placeholder "Search Segments".

  3. Select one segment by clicking on it (maximum 1 selection allowed).

  4. Remove segment by clicking the remove button on the selected segment.

  5. Segments are automatically applied and update the dashboard data.

API Requests Analysis - Add Segment
API Requests Analysis - Add Segment

Chart Analytics

Creating and Viewing Charts

Chart Types Available

  • Time Series Charts: Interactive line charts showing API performance trends over time

  • Multiple Metrics: Select multiple API performance metrics for comparison

Chart Interactions

  1. Hover over data points to see detailed API performance information and tooltips.

  2. Zoom and Pan: Use mouse or touch gestures to zoom into specific time periods.

  3. Legend Toggle: Click legend items to show/hide specific data series.

Chart Customization

Chart Features

  • Advanced Interactions: Full zoom, pan, and selection capabilities

  • Detailed Tooltips: Comprehensive tooltip information with API-specific metrics

API Requests Analysis
API Requests Analysis

Analytics Table

Summary Tables

The analytics table provides comprehensive breakdowns of API request metrics across different segments:

Table Features

  • Sortable Columns: Click column headers to sort data by various API metrics

  • Pagination: Navigate through large datasets efficiently

  • Search Functionality: Built-in search input for filtering table data

  • Loading States: Loading animation during data fetch operations

  • No Data Handling: Custom messages for different no-data scenarios

API Requests Analysis - Summary Table
API Requests Analysis - Summary Table

Table Actions and Interactions

Performance Metrics

  • Success Rates: View API success rates with trend indicators and historical comparisons

  • Latency Analysis: Monitor response times across different percentiles (TP50, TP95, TP99)

  • Error Distribution: Detailed error analysis by HTTP status codes and error patterns

Spike Analysis

Latency Spike Analysis

Purpose: Identifies periods when API response times significantly exceed normal patterns

Features

  • Table Heading: "Latency Spike Analysis"

  • Time Limitation: Analysis restricted to maximum 1-hour intervals for accuracy

  • Automatic Detection: System automatically identifies latency anomalies

  • Root Cause Investigation: Detailed analysis of factors contributing to latency spikes

Default Columns

  • affected_entity: API entity experiencing latency spikes

  • current_average_latency: Current latency values displayed with millisecond units

  • volume_of_hits: Number of API requests with formatted numbers for readability

  • root_cause: Expandable root cause analysis using SpikedEntityCell component

Time Restrictions

  • Maximum Interval: 1-hour maximum for latency spike analysis

  • Restriction Message: "Latency Spike analysis can be done only within a maximum of 1-hour interval"

  • No Data Message: "No latency spikes noticed in the selected time range"

5xx Error Spike Analysis

Purpose: Detects increases in server error rates that may indicate system issues

Features

  • Table Heading: "5xx Spike Analysis"

  • No Time Restriction: Available for any time range selection

  • Server Error Focus: Specifically monitors HTTP 5xx status codes

  • System Health Monitoring: Identifies potential system-wide issues

Default Columns

  • affected_entity: API entity experiencing 5xx error spikes

  • rate_of_5xx: Error rate displayed as percentage with precision formatting

  • volume_of_hits: Number of API requests with formatted numbers

  • root_cause: Expandable root cause analysis using SpikedEntityCell component

Analysis Features

  • No Time Restriction: Available for any selected time range

  • No Data Message: "No 5xx spikes noticed in the selected time range"

  • Real-time Detection: Continuous monitoring for server error patterns

Root Cause Analysis

SpikedEntityCell Component

The SpikedEntityCell component provides detailed investigation tools for spike analysis:

Expandable Views:

  • "VIEW MORE (+)": Expands to show additional affected entities and detailed metrics

  • "VIEW LESS (-)": Collapses the view to show summary information

  • Multiple Entities: Handles display of multiple affected entities in a single spike event

Help Integration:

  • "RAISE A TICKET" button: Opens help modal for support ticket creation

  • Pre-populated Information: Automatically includes entity-specific information, time range, and metric values

  • Context-Aware Support: Support tickets include affected entity name, spike metrics, and time context

Data Display:

  • Gateway Information: Shows gateway name and API name for context

  • Entity Values: Displays specific entity values contributing to the spike

  • Formatted Metrics: 5xx rates as percentages, latency values with millisecond units

Sync and Refresh

Manual Refresh

Sync Button

  • Purpose: Manually refresh all dashboard data to get the most current information

  • Usage: Click the "Sync" button to trigger immediate data refresh

  • When to Use: When you need immediate data updates or suspect data staleness

  • Visual Feedback: Loading indicators show refresh progress across all components

Data Export

Export Table Functionality

The API requests analytics module provides a simple table export feature that downloads the currently visible table data.

How to Export

  1. Apply Filters: Set your desired time range and segments to filter the data in the summary table.

  2. Click "Export Table": Use the "Export Table" button located in the top-right corner of the Summary Table section.

  3. Download: The system will immediately download a CSV file containing all the data currently displayed in the table.

Export Details

  • File Format: CSV (Comma Separated Values)

  • Data Included: All rows and columns currently visible in the Summary Table

  • Filename: Automatically generated with timestamp and applied filters

  • Content: Exports exactly what you see in the table - no additional field selection required

Use Cases

Real-Time API Health Monitoring

  • Set last 1-6 hours time range

  • Monitor API Availability Rate and 5xx Error Rate

  • Use Spike Analysis for anomaly detection

API Error Pattern Analysis

  • Apply 5xx Spike Analysis for server errors

  • Use path segment for endpoint analysis

  • Apply res_err_code for error categorization

Gateway Performance Optimization

  • Apply gateway segment for comparison

  • Use Latency Spike Analysis (1-hour max)

  • Analyze latency percentiles (TP50, TP95, TP99)

Permissions and Roles

Access to the API Requests Analytics module is controlled by the following permissions:

  • API Requests Analytics Module Access: Required for accessing the API requests analytics dashboard

  • Analytics Read Permission: Needed to view metrics, charts, and spike analysis

  • Analytics Export Permission: Required for downloading API request data and reports

Last updated 5 months ago