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

# Obter o compartilhamento do relatório

> Veja se o relatório de um monitor está publicado, para quem e em qual endereço.



## OpenAPI

````yaml GET /v1/monitors/{id}/share
openapi: 3.1.0
info:
  title: querying.ai
  description: >-
    One API for every AI answer engine. Every task is asynchronous: submit, then
    collect the result via webhook or polling.
  version: 1.0.0
servers:
  - url: https://api.querying.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/monitors/{id}/share:
    get:
      tags:
        - Monitors
      summary: Get report sharing
      description: >-
        Whether the monitor's report is published at querying.ai/<slug>, to whom
        and in which language, with a suggested slug to offer when none is set
        yet.
      operationId: getMonitorShare
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The current sharing state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorShareResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    MonitorShareResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          const: true
        data:
          allOf:
            - $ref: '#/components/schemas/MonitorShare'
            - type: object
              required:
                - suggestedSlug
              properties:
                suggestedSlug:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The current slug when one is set. Otherwise one derived from
                    the first usable domain (without its TLD) or the name, or
                    null when it is already taken or nothing usable can be
                    derived.
    MonitorShare:
      type: object
      required:
        - access
        - slug
        - locale
        - url
      properties:
        access:
          type: string
          enum:
            - PRIVATE
            - LINK
            - PUBLIC
          description: >-
            PRIVATE: only you. LINK: anyone with the URL, not indexed. PUBLIC:
            anyone, and search engines may index it.
        slug:
          type:
            - string
            - 'null'
          description: >-
            The address segment, kept when access goes back to PRIVATE. null
            until one is set.
        locale:
          type: string
          enum:
            - en
            - ko
            - ja
            - zh
            - es
            - fr
            - de
            - pt
          description: The language the report renders in for every reader.
        url:
          type:
            - string
            - 'null'
          description: >-
            https://querying.ai/<slug>, or null when no slug is set. It serves
            the report only while access is LINK or PUBLIC.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          $ref: '#/components/schemas/ErrorDetail'
    ErrorDetail:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable, safe to branch on. See the Errors guide for the full list.
        message:
          type: string
          description: For humans. May change.
        details:
          description: >-
            Context for the error. An array of `{field, message}` on most
            `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on
            `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted
            when there is nothing to add.
          oneOf:
            - type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
            - type: object
              additionalProperties: true
        timestamp:
          type: string
          format: date-time
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: MISSING_API_KEY
              message: Missing or invalid API key
              timestamp: '2026-07-09T04:12:00.000Z'
    NotFound:
      description: >-
        No monitor with that id for this key, or no scored row with that task
        id. A monitor owned by another account is reported the same way rather
        than as a 403.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: NOT_FOUND
              message: No monitor with that id
              timestamp: '2026-09-22T04:12:00.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer <key>`.'

````

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