> ## Documentation Index
> Fetch the complete documentation index at: https://docs.moduluslabs.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Ping

> Public health check endpoint to verify Transaction Reporting API connectivity and availability

The Ping endpoint is a simple health check that allows you to:

* Test connectivity to Modulus Labs servers
* Verify API availability and response time
* Confirm your network can reach the API endpoints

<Tip>
  This endpoint does not require authentication, making it perfect for quick connectivity tests and uptime monitoring.
</Tip>

<Check>
  If you receive `Pong!`, the API is available and your network connectivity is working!
</Check>


## OpenAPI

````yaml api-reference/transaction-reporting/openapi.json GET /ping
openapi: 3.0.3
info:
  title: Transaction Reporting API
  description: >-
    Unified REST API for querying transaction history across all payment
    methods. Provides entity-scoped data isolation with cursor-based pagination.


    **Entity Hierarchy:** Partner → Merchant → Branch → Terminal → Transaction.
    All data access is scoped to the authenticated API key's entity level.


    **Cursor Pagination:** All list endpoints use opaque cursor-based
    pagination. Default page size is 20, maximum is 100.


    **Sorting:** Transactions can be sorted by `created_at` (default),
    `updated_at`, or `amount` in ascending or descending order.


    **Unified Response Model:** All transactions use the same `amount_details`
    schema regardless of payment method. The canonical GTV field is
    `amount_received`.
  version: 1.1.0
  contact:
    name: API Support
    email: support@moduluslabs.io
  license:
    name: Proprietary
servers:
  - url: https://api.sbx.moduluslabs.io/reports
    description: Sandbox
security:
  - ApiKeyAuth: []
tags:
  - name: Transactions
    description: Transaction queries and reporting
  - name: Entities
    description: Merchant and branch listing
  - name: Health
    description: Health check endpoints
paths:
  /ping:
    get:
      tags:
        - Health
      summary: Ping
      description: >-
        Public health check endpoint to verify Transaction Reporting API
        connectivity and availability. This endpoint does not require
        authentication.
      operationId: pingTransactionReporting
      responses:
        '200':
          description: API is available and responding
          content:
            text/plain:
              schema:
                type: string
                example: Pong!
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security: []
components:
  responses:
    ServiceUnavailable:
      description: Both database circuit breakers are open, or registry unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >
        API key for authentication. Verified by APISIX via Vanguard.

        APISIX injects identity headers and strips the raw key before
        forwarding.

````