Skip to content

View Captured Payloads

The Payload dashboard in Monitor & Analytics lets you view captured request and response payloads from APIs that have Payload Capture enabled.

This page is the analytics and troubleshooting layer of Payload Capture. Configuration is done elsewhere — you do not create or edit capture policies here.

Overview

When a Payload Capture policy is active on an endpoint, the gateway captures request and/or response payloads for authentication requests and error scenarios. Captured data is stored according to the platform retention settings configured in the Admin Console.

The Payload dashboard provides:

  • A searchable, filterable list of captured payloads
  • Correlation IDs for tracing individual requests
  • A detailed view of request and response bodies (JSON or XML)
  • Masked sensitive fields based on platform defaults and endpoint policy settings

Prerequisites

Before using the Payload dashboard, ensure:

  • Global Payload Capture is enabled in the Admin Console (Enable Payload is on)
  • A Payload Capture policy is attached to the target API endpoint
  • The endpoint policy is enabled (use the Payload Capture Enabled/Disabled switch on the endpoint tab if needed)
  • Matching traffic has occurred — payloads are captured for authentication requests and error scenarios
  • Open API Manager
  • Navigate to Monitor & Analytics → Payload in the sidebar
  • The Payload dashboard opens

Dashboard Overview

Element Description
Page title Payload
Description "View captured request and response payloads from APIs with Payload Capture enabled."
Search Filter by API name or endpoint name
Capture mode Filter by All, Request, Response, or Both
Grid Paginated list of captured payload records
View payload Eye icon to open the full request/response detail modal

Grid Columns

Column Description
Correlation Id Unique identifier for the captured request
API name Name of the API where the payload was captured
Endpoint name Endpoint that handled the request
Capture mode Whether the request body, response body, or both were captured
Timestamp When the payload was captured
View payload Opens the detail modal for request and response bodies

Filters

Search by API or endpoint name

  • Use the search field to filter records by API name or endpoint name.
  • Results update as you type.

Capture mode

Option Shows
All All captured records
Request Records where the request body was captured
Response Records where the response body was captured
Both Records where both request and response were captured

View Payload Modal

Click the View payload (eye) icon on any row to open the detail modal.

The modal displays:

  • Metadata — API name, endpoint name, capture mode, and timestamp
  • Request body — Captured request payload (formatted as JSON or XML)
  • Response body — Captured response payload (formatted as JSON or XML)

Sensitive fields listed in the platform default masking settings and the endpoint Payload Capture policy are masked in the displayed bodies.

Step-by-Step: Find a Captured Payload

  1. Navigate to Monitor & Analytics → Payload.
  2. Use the search field to find records by API or endpoint name.
  3. Optionally filter by Capture mode (Request, Response, or Both).
  4. Locate the target record in the grid.
  5. Click the View payload icon to inspect the request and response bodies.
  6. Review the correlation ID if you need to cross-reference with other logs.

Verification

After configuring Payload Capture on an endpoint:

  • Send test API calls that trigger authentication or error responses on the endpoint.
  • Open the Payload dashboard and search for the API or endpoint name.
  • Confirm new records appear with the expected capture mode and timestamp.
  • Open View payload and verify request/response bodies are present and masked fields are hidden.

Troubleshooting

Issue Possible Cause Resolution
Empty dashboard Platform feature disabled, no policy attached, or policy disabled Enable global Payload Capture; attach and enable endpoint policy; trigger auth/error traffic
Expected payload missing Capture context does not include the relevant body Edit the policy Select Context to Request, Response, or Both as needed
Sensitive data visible Field not in masking list Add masked fields to the endpoint policy or admin default masking
Record truncated Payload exceeds max capture size Review Max Payload capture size (MB) in Admin Console
Old records disappeared Retention period elapsed Expected behavior — data is purged after the configured retention duration