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

# Query Project Metrics

> Query recent Prometheus-compatible metrics for a project. Results are project-scoped server-side. Raw PromQL is not accepted.



## OpenAPI

````yaml https://api.veryfront.com/openapi.json post /projects/{project_reference}/metrics/query
openapi: 3.1.0
info:
  title: Veryfront REST API
  version: 1.0.0
  summary: Domain-first REST reference for the maintained Veryfront HTTP API surface.
  description: >-
    Project-first HTTP API for Veryfront project resources. Root
    account/platform endpoints that still appear in this reference are
    transitional compatibility surfaces unless the canonical inventory marks
    them otherwise.


    ## Start here


    - **Interactive REST reference:** [/docs](/docs)

    - **Raw OpenAPI document:** [/openapi.json](/openapi.json)

    - **Canonical inventory:** `docs/api-surface-inventory.md` in this
    repository

    - **GraphQL endpoint:** [/graphql](/graphql)

    - **MCP playground:** [/mcp/playground](/mcp/playground)


    ## Authentication


    Use one of these request headers:


    - `Authorization: Bearer <jwt>`

    - `Authorization: Bearer vf_<prefix>_<secret>`

    - `X-API-Key: vf_<prefix>_<secret>`


    JWTs must use the Bearer token contract. API keys work in either the Bearer
    header or `X-API-Key`.


    ## Discovery model


    Veryfront is one platform with multiple access modes:


    - **REST** for resource-oriented and operational HTTP workflows

    - **GraphQL** for connected app-facing data and typed mutations

    - **MCP** for tool-style automation and agent workflows


    For the fastest path through the platform, start with the project-scoped
    domain groups. Transitional account/platform groups are retained for
    compatibility and follow the removal register in the canonical inventory.
  contact:
    name: Veryfront API Support
    url: https://veryfront.com/docs
    email: support@veryfront.com
servers:
  - url: https://api.veryfront.com
    description: Current request origin
  - url: http://localhost:4000
    description: Local development
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Projects
    description: Core project operations
  - name: Account
    description: >-
      Transitional account-level users and settings retained for dashboard
      compatibility
  - name: Project Users
    description: Project members and invites
  - name: Members
    description: Project members and invites
  - name: Files
    description: Main branch files
  - name: Branch Files
    description: Files on branches
  - name: Environment Files
    description: Files in environments
  - name: Release Files
    description: Files in releases
  - name: Uploads
    description: File uploads and assets
  - name: Branches
    description: Content branches for previews
  - name: Releases
    description: Published file snapshots
  - name: Deployments
    description: Connect releases to environments
  - name: Environments
    description: Deployment targets and variables
  - name: Environment Variables
    description: Project environment variable management
  - name: Domains
    description: Custom domains for environments
  - name: Project Servers
    description: Project-scoped dedicated server instances
  - name: Root Servers
    description: >-
      Transitional root dedicated-server administration retained for
      compatibility
  - name: Tasks
    description: Project tasks
  - name: Evals
    description: Project eval definitions and eval run projections
  - name: Work
    description: Project business-process definitions and execution state
  - name: Workflows
    description: Project workflows
  - name: Workflow Runs
    description: Workflow run history and status
  - name: Schedules
    description: Recurring project automation schedules
  - name: Webhooks
    description: Webhook-triggered automation entry points
  - name: Skills
    description: Project skills
  - name: Prompts
    description: Project prompts
  - name: Tools
    description: Project tools
  - name: Resources
    description: Project-defined resource documents and source-backed resource definitions
  - name: Sandboxes
    description: Ephemeral sandbox execution environments
  - name: Search
    description: Text and vector search
  - name: Knowledge
    description: Knowledge manifest lookup across project knowledge files
  - name: Chunks
    description: File chunks for search indexing
  - name: Embeddings
    description: Vector embeddings
  - name: RAG Documents
    description: Project retrieval-augmented knowledge documents
  - name: Style Artifacts
    description: Project style artifact state and build outputs
  - name: External Storage
    description: Transitional connected cloud-provider file operations
  - name: Project Cache
    description: Project-scoped distributed cache operations
  - name: User Cache
    description: Transitional user cache helpers retained for compatibility
  - name: API Keys
    description: >-
      Transitional user/account API key management; prefer project-scoped keys
      for public integrations
  - name: User
    description: Transitional current-user profile endpoint for first-party clients
  - name: Favorites
    description: Transitional user favorites for first-party dashboard clients
  - name: Subscriptions
    description: Transitional account billing and subscription workflows
  - name: Credits
    description: Transitional account credit balance, purchase, and insufficiency flows
  - name: Usage
    description: >-
      Project/account usage limits and warnings; account-level usage is
      transitional
  - name: Gates
    description: Transitional plan and feature gate checks for first-party clients
  - name: Channels
    description: Project channel integrations and delivery settings
  - name: Agents
    description: Project agents
  - name: Agent Catalog
    description: Public catalog of agents assembled from curated template projects
  - name: Agent Workers
    description: Internal/transitional agent worker leases and sessions
  - name: Agent Runtimes
    description: Registered push-based agent runtime services and runtime target health
  - name: Project Integrations
    description: Project-scoped integration catalog and configuration
  - name: Integrations
    description: Transitional external integration catalog for first-party clients
  - name: Integration Tools
    description: >-
      Transitional dynamic integration tool listing, invocation, and connection
      state
  - name: OAuth
    description: >-
      Transitional OAuth integration flows for first-party and connected-app
      clients
  - name: Templates
    description: Transitional starter-template discovery used during project creation
  - name: AI
    description: >-
      Transitional platform AI gateway/model helpers; project AI assets use
      project-scoped routes
  - name: Images
    description: Generated images and image assets
  - name: Conversations
    description: Transitional conversation/run-control HTTP surface for first-party clients
  - name: Runs
    description: Transitional hosted run-control endpoints for conversation execution
  - name: MCP
    description: >-
      MCP catalog/playground helpers; primary MCP traffic uses the streamable
      MCP handler
  - name: Logs
    description: Project log queries via Loki
  - name: Metrics
    description: Project metric queries via a Prometheus-compatible backend
  - name: Traces
    description: Project trace queries via Grafana Tempo
  - name: Errors
    description: Internal/public error type catalog (RFC 9457)
  - name: Authentication
    description: Transitional auth token, login, logout, magic-link, and JWKS flows
externalDocs:
  description: Interactive REST reference
  url: https://api.veryfront.com/docs
paths:
  /projects/{project_reference}/metrics/query:
    post:
      tags:
        - Metrics
      summary: Query Project Metrics
      description: >-
        Query recent Prometheus-compatible metrics for a project. Results are
        project-scoped server-side. Raw PromQL is not accepted.
      operationId: queryProjectMetrics
      parameters:
        - schema:
            type: string
            description: >-
              Project slug or UUID. The resolved project is used to scope all
              metric reads server-side.
          required: true
          name: project_reference
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metric:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Prometheus metric name. Raw PromQL is not accepted.
                start:
                  type: string
                  description: Start time (ISO 8601). Defaults to 1 hour ago.
                end:
                  type: string
                  description: End time (ISO 8601). Defaults to now.
                step:
                  type: string
                  minLength: 1
                  maxLength: 20
                  default: 60s
                  description: Prometheus query step, for example 60s.
                aggregation:
                  type: string
                  enum:
                    - none
                    - sum
                    - avg
                    - min
                    - max
                    - count
                  default: none
                  description: Aggregation to apply to the project-scoped metric selector.
                labels:
                  type: object
                  additionalProperties:
                    type: string
                  description: >-
                    Optional allowlisted label filters such as service_name or
                    status_code.
              required:
                - metric
      responses:
        '200':
          description: Metric query results
          content:
            application/json:
              schema:
                type: object
                properties:
                  series:
                    type: array
                    items:
                      type: object
                      properties:
                        metric:
                          type: string
                          description: The metric associated with this tool result.
                        labels:
                          type: object
                          additionalProperties:
                            type: string
                            description: >-
                              Additional structured values associated with this
                              result.
                          description: >-
                            Structured labels details associated with this tool
                            result.
                        points:
                          type: array
                          items:
                            type: object
                            properties:
                              timestamp:
                                type: string
                                description: >-
                                  The timestamp associated with this tool
                                  result.
                              value:
                                type: number
                                description: The value associated with this tool result.
                            required:
                              - timestamp
                              - value
                            description: One point item associated with this tool result.
                          description: List of points associated with this tool result.
                      required:
                        - metric
                        - labels
                        - points
                      description: One sery item associated with this tool result.
                    description: List of series associated with this tool result.
                  stats:
                    type: object
                    properties:
                      query_time_ms:
                        type: number
                        description: The query time ms associated with this tool result.
                    required:
                      - query_time_ms
                    description: Structured stats details associated with this tool result.
                required:
                  - series
                  - stats
        '400':
          description: Invalid metric query parameters
        '401':
          description: Unauthorized
        '404':
          description: Project not found
        '429':
          description: Rate limit exceeded
        '502':
          description: >-
            External metric provider error from the Prometheus-compatible read
            path
        '503':
          description: >-
            Metric service unavailable or Prometheus-compatible read path is not
            configured
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use a JWT bearer token or a Veryfront API key in the Authorization
        header.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative API key header for vf_<prefix>_<secret> tokens.

````