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

# List recent push attempts

> Lists the tenant's newest push attempts, newest first.



## OpenAPI

````yaml /reference/openapi.yaml get /push-events
openapi: 3.1.0
info:
  title: pgw admin API
  version: 0.4.0
  description: |
    Manage a pgw tenant: its apps, upstreams, managed mode users, bindings,
    and push log.

    The API listens on `admin_listen`, `127.0.0.1:8080` by default, over plain
    HTTP. Every endpoint except `POST /bootstrap`, `POST /tls/reload`, and the
    register bans needs a tenant API key in the `Authorization` header. Those
    need the server's `PGW_BOOTSTRAP_TOKEN`. Request bodies are JSON objects
    of at most 1 MiB, or 16 MiB for `POST /config/sync`, and pgw rejects
    unknown fields. Responses are never cached.

    An unknown path gets `404`, and a method that the path doesn't serve gets
    `405` with an `Allow` header. Every `GET` endpoint also answers `HEAD`.
    An endpoint that needs an API key answers `500` when pgw can't check the
    key.

    The same listener also serves `GET /metrics`, `GET /healthz`, and
    `GET /readyz`, outside `/api/v1` and without authentication. The health
    checks and metrics pages describe them.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: '{baseUrl}'
    description: Your pgw admin listener
    variables:
      baseUrl:
        default: http://127.0.0.1:8080/api/v1
        description: The address of admin_listen, followed by /api/v1.
  - url: http://localhost:8080/api/v1
    description: pgw on this computer
security:
  - apiKey: []
tags:
  - name: Tenant
    description: Create the first tenant and read the caller's tenant.
  - name: Apps
    description: Mobile and web apps and their push credentials.
  - name: Upstreams
    description: PBXs that pgw registers apps with.
  - name: Users
    description: >-
      SIP accounts that pgw checks itself and registers at the PBX in managed
      mode.
  - name: Bindings
    description: Devices registered through pgw.
  - name: Push events
    description: The log of push attempts.
  - name: TLS
    description: The certificate that pgw presents to apps.
  - name: Register bans
    description: >-
      Source addresses that pgw refuses REGISTERs from after too many refused
      credentials.
  - name: Config
    description: Export a tenant's configuration and make it match a snapshot.
paths:
  /push-events:
    get:
      tags:
        - Push events
      summary: List recent push attempts
      description: Lists the tenant's newest push attempts, newest first.
      operationId: listPushEvents
      parameters:
        - name: limit
          in: query
          required: false
          description: The number of events to return.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 100
      responses:
        '200':
          description: The newest push attempts.
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PushEvent'
              example:
                items:
                  - id: 4182
                    binding_key: Bk2mR7xQ4tLw9NvP1yZc5g
                    type: call
                    provider: apns
                    push_type: voip
                    status_code: 200
                    latency_ms: 87
                    call_id: 5e2b7c1a9f3d4e60@192.0.2.10
                    created_at: '2026-11-16T09:41:07Z'
                  - id: 4181
                    binding_key: Mg6vN3pQ8wLr1XkT5zBc2A
                    type: call
                    provider: fcm
                    push_type: data
                    status_code: 503
                    latency_ms: 142
                    error: 'fcm: 503'
                    call_id: 0c4d8e2f6a1b3c57@192.0.2.10
                    created_at: '2026-11-16T09:38:52Z'
                  - id: 4180
                    binding_key: Bk2mR7xQ4tLw9NvP1yZc5g
                    type: test
                    provider: apns
                    push_type: background
                    status_code: 200
                    latency_ms: 64
                    created_at: '2026-11-16T09:35:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PushEvent:
      type: object
      required:
        - id
        - binding_key
        - type
        - provider
        - push_type
        - status_code
        - latency_ms
        - created_at
      properties:
        id:
          type: integer
          format: int64
        binding_key:
          type: string
        type:
          type: string
          enum:
            - call
            - missed
            - refresh
            - test
        provider:
          type: string
        push_type:
          type: string
          description: The provider's push type, such as `voip` or `alert` for APNs.
        status_code:
          type: integer
          description: The provider's HTTP status code.
        latency_ms:
          type: integer
        error:
          type: string
        call_id:
          type: string
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong. Never contains the values that you sent.
  responses:
    BadRequest:
      description: >-
        The request body or a parameter isn't valid. The message names the
        field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            field:
              summary: A field that isn't valid
              value:
                error: 'invalid request: platform must be "ios", "android", or "web"'
            json:
              summary: A body that isn't valid JSON
              value:
                error: 'invalid JSON body: unknown field "colour"'
            limit:
              summary: A query parameter out of range
              value:
                error: limit must be from 1 to 1000
    Unauthorized:
      description: The API key is missing or unknown.
      headers:
        WWW-Authenticate:
          schema:
            type: string
            const: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or unknown API key
    InternalError:
      description: pgw failed to complete the request. The details are in pgw's log.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: The tenant API key that `POST /bootstrap` returned.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.