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

# Send a test log

> Sends one real, visible test log through the full delivery path and reports whether it arrived. Limited to one per server per minute.

The response is 200 even if the log did not arrive. Check `ok` and `stage`.



## OpenAPI

````yaml /api-reference/openapi.json post /servers/{guild_id}/troubleshoot/test-log
openapi: 3.1.0
info:
  title: Quark API
  version: 2.0.0
  description: Configure Quark and read your server's logs from your own code.
servers:
  - url: https://quark.bot/api
security:
  - bearerAuth: []
tags:
  - name: Configuration
    description: Read the configuration and change server settings.
  - name: Log channels
    description: Where each category of log is sent.
  - name: Logging settings
    description: Server-wide options and settings for individual log types.
  - name: Ignore options
    description: Channels, members, roles and message content left out of the logs.
  - name: Tags
    description: Saved messages posted with /tags send.
  - name: Logs
    description: Read and export the server's logs.
  - name: Notifications
    description: Recent changes to Quark's configuration.
  - name: Troubleshooting
    description: Find out why logs are missing, and fix it.
  - name: Search
    description: Look up members and channels.
  - name: Tokens
    description: List and revoke API tokens.
  - name: Server
    description: Reset the server.
paths:
  /servers/{guild_id}/troubleshoot/test-log:
    post:
      tags:
        - Troubleshooting
      summary: Send a test log
      description: >-
        Sends one real, visible test log through the full delivery path and
        reports whether it arrived. Limited to one per server per minute.


        The response is 200 even if the log did not arrive. Check `ok` and
        `stage`.
      operationId: sendTestLog
      parameters:
        - $ref: '#/components/parameters/GuildId'
        - $ref: '#/components/parameters/Bot'
      responses:
        '200':
          description: The result of the test.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestLogResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          description: >-
            A test log was sent less than a minute ago, or you are being rate
            limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    GuildId:
      name: guild_id
      in: path
      required: true
      schema:
        type: string
        pattern: ^\d{17,20}$
        example: '301655085954367490'
      description: The server's ID. Must be the server the token was created for.
    Bot:
      name: bot
      in: query
      required: false
      schema:
        type: string
        enum:
          - pro
      description: >-
        Set to `pro` to act on the Quark Pro bot's configuration. Leave out for
        the main Quark bot.
  schemas:
    TestLogResult:
      type: object
      properties:
        ok:
          type: boolean
        stage:
          type: string
          enum:
            - delivered
            - no_channel
            - webhook_404
            - channel_parked
            - local_rate_limit
            - forbidden
            - rate_limited
            - request_timeout_or_network
            - unknown
          description: Where the log got to.
        channelId:
          type:
            - string
            - 'null'
        httpStatus:
          type:
            - integer
            - 'null'
        detail:
          type:
            - string
            - 'null'
        latencyMs:
          type:
            - integer
            - 'null'
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: No token was sent.
      content:
        application/json:
          schema:
            type: object
            description: An empty object.
            example: {}
    Forbidden:
      description: The token belongs to a different server, or is not an Admin token.
      content:
        application/json:
          schema:
            type: object
            description: An empty object.
            example: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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