Skip to main content

Get a single request

GET 
/v2/endpoints/:endpoint/requests/:requestId

Retrieves complete details for a specific request by its unique identifier. This endpoint always returns the verbose format with full request and response payloads.

Purpose​

Use this endpoint to:

  • Inspect the full details of a specific request
  • Debug why a particular request succeeded or failed
  • View the exact headers and body sent by the client
  • Examine the response that Beeceptor returned
  • Analyze proxy/callout details if the request was forwarded

Response Structure​

The response includes all available information about the request:

Core Fields:

  • id: Unique request identifier
  • date: ISO 8601 timestamp when request was received
  • method: HTTP method (GET, POST, PUT, DELETE, etc.)
  • path: Full request path including query parameters
  • status: HTTP response status code returned
  • timeTaken: Processing time in milliseconds

Rule Matching:

  • rule.matched: Boolean indicating if a mock rule matched
  • rule.ruleId: ID of the matched rule (if any)
  • rule.weightedResponse: Name of selected response (for weighted rules)

Request Details:

  • request.body: Raw request body content
  • request.headers: Object containing all request headers
  • request.httpVersion: HTTP version used (e.g., "HTTP/1.1", "HTTP/2")
  • request.isMultipart: Boolean for multipart/form-data requests
  • request.multipartData: Array of file/field metadata (for multipart requests)
  • request.redacted: Boolean indicating if sensitive data was masked

Response Details:

  • response.body: Raw response body content
  • response.headers: Object containing all response headers
  • response.httpVersion: HTTP version used
  • response.blob: Boolean if response was served from blob storage
  • response.blobPath: Path to blob file (if blob response)
  • response.redacted: Boolean indicating if sensitive data was masked

Callout Details (if request was proxied):

  • callout.url: Target URL for the callout
  • callout.method: HTTP method used for callout
  • callout.behavior: Sync or async callout
  • callout.delay: Artificial delay applied (if any)
  • callout.targetRequest: Headers and body sent to upstream
  • callout.targetResponse: Headers and body received from upstream

gRPC Requests: For gRPC requests, the structure differs slightly:

  • request.messages: Array of gRPC request messages with body, headers, timestamp
  • response.messages: Array of gRPC response messages with body, timestamp

Use Cases​

  • Debugging Integration Issues: Examine exact payloads when API calls fail
  • Webhook Verification: Confirm webhook payloads match expectations
  • Rule Testing: Verify that the correct rule matched a request
  • Proxy Analysis: Inspect both client and upstream communications
  • Support Requests: Share specific request details when reporting issues

Request​

Responses​

Request details (verbose format with full details)