> ## 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.

# モニター機能一覧を取得

> モニタリングの仕様（スケジュール可能なエンジン、価格、制限、指標の定義）を取得します。



## OpenAPI

````yaml GET /v1/monitors/capabilities
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/capabilities:
    get:
      tags:
        - Monitors
      summary: Get monitor capabilities
      description: >-
        The monitoring contract as data: which engines a monitor may schedule
        and what each task costs in credits, the published limits, the
        definition of every metric a report returns, the workflow the endpoints
        implement, and how a schedule consumes credits. A cheap read with no
        side effects — call it before configuring anything or writing a
        dashboard.
      operationId: getMonitorCapabilities
      responses:
        '200':
          description: >-
            Engines, limits, metric definitions, workflow and schedule
            economics.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorCapabilitiesResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    MonitorCapabilitiesResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          properties:
            engines:
              type: array
              description: >-
                Engines a monitor may schedule, in preference order, with the
                credits one task on each costs.
              items:
                type: object
                properties:
                  engine:
                    $ref: '#/components/schemas/MonitorEngine'
                  creditsPerTask:
                    type: number
            limits:
              type: object
              description: >-
                This account's numeric limits, each enforced on create and
                update. A contract account has platform-scale monitors,
                tasksPerRun and prompts.
              properties:
                monitors:
                  type: integer
                tasksPerRun:
                  type: integer
                  description: >-
                    Ceiling on one run's tasks: prompts × points × samples,
                    summed over engines.
                prompts:
                  type: integer
                competitors:
                  type: integer
                  description: >-
                    Competitor brands you may list on a BRAND monitor. roster
                    has the limit for each mode.
                roster:
                  type: object
                  description: >-
                    Brands per mode: typed is what you may list, auto is what
                    the weekly read may add beside them.
                  properties:
                    BRAND:
                      type: object
                      properties:
                        typed:
                          type: integer
                        auto:
                          type: integer
                    CATEGORY:
                      type: object
                      properties:
                        typed:
                          type: integer
                        auto:
                          type: integer
                categoryCharacters:
                  type: integer
                  description: Longest category name.
                subFields:
                  type: integer
                  description: Sub-fields a CATEGORY monitor may hold.
                subFieldCharacters:
                  type: integer
                  description: Longest sub-field name.
                aliases:
                  type: integer
                domains:
                  type: integer
                intervalHours:
                  type: object
                  properties:
                    min:
                      type: integer
                    max:
                      type: integer
                analyticsDays:
                  type: integer
                  description: Maximum report window in days.
                resultPageSize:
                  type: integer
                evidencePageSize:
                  type: integer
                sourcePageSize:
                  type: integer
                answerTextCharacters:
                  type: integer
                  description: >-
                    Retained answer characters; longer answers are cut and
                    marked with a trailing ellipsis.
                samples:
                  type: integer
                  description: >-
                    Most answers per prompt and engine in one run
                    (engineSettings.samples).
            modes:
              type: object
              description: One line on what each monitor mode measures.
              properties:
                BRAND:
                  type: string
                CATEGORY:
                  type: string
            metrics:
              type: object
              description: >-
                The published definition of every metric a report returns, as
                prose. Read it before labelling a dashboard panel.
              properties:
                mentionRate:
                  type: string
                citationRate:
                  type: string
                shareOfVoice:
                  type: string
                opportunity:
                  type: string
                noAnswer:
                  type: string
                comparison:
                  type: string
                categoryMentionRate:
                  type: string
                categoryRank:
                  type: string
                categoryNamedRate:
                  type: string
            workflow:
              type: array
              items:
                type: string
              description: The endpoints in the order a report is assembled.
            schedule:
              type: object
              properties:
                starts:
                  type: string
                  const: on_create
                cost:
                  type: string
                  description: Credits one run spends.
                monthlyEstimate:
                  type: string
                pausedRunAllowed:
                  type: boolean
                  const: false
                  description: A paused monitor cannot be run on demand.
                engineIntervals:
                  type: string
                  description: How engineSettings.intervalHours spaces an engine's runs.
            events:
              type: object
              description: The change events a monitor with a webhookUrl sends.
              properties:
                types:
                  type: array
                  items:
                    type: string
                    enum:
                      - monitor.mention.started
                      - monitor.mention.stopped
                      - monitor.competitor.ahead
                      - monitor.source.first_cited
                answersPerState:
                  type: integer
                  description: >-
                    Answers a prompt's state is read over; the first full window
                    is the baseline and sends nothing.
                delivery:
                  type: string
            analysisCreditsPerTask:
              type: number
              description: >-
                Credits `analysis: true` adds to each task, charged only when
                the analysis succeeds.
    MonitorEngine:
      type: string
      description: >-
        An engine a monitor can schedule: the prompt surfaces sold to customers
        plus the deprecated NAVER alias. GOOGLE_AIO and GOOGLE_AIMODE are
        accepted as input aliases and echoed as GOOGLE and AIMODE.
        CITATION_ANALYSIS is an analysis task, not a prompt surface, and cannot
        be scheduled on a monitor.
      enum:
        - CHATGPT
        - GEMINI
        - PERPLEXITY
        - GOOGLE
        - AIMODE
        - NAVER_AI_BRIEF
        - NAVER_AI_TAB
        - NAVER
    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'
  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.