Grafana Render API

openapi: 3.2.0
info:
  title: Grafana Render API
  description: 'Grafana is an open-source analytics and visualization platform that helps you monitor and analyze data from various sources. It lets you create customizable dashboards with charts, graphs, and alerts to visualize metrics and logs in real-time. Commonly used for monitoring infrastructure, applications, and business metrics, Grafana connects to dozens of data sources like Prometheus, Elasticsearch, and cloud platforms, making it easier to understand system performance, troubleshoot issues, and track key indicators all in one place. '
  contact:
    name: Grafana Labs
    url: https://grafana.com
    email: hello@grafana.com
  version: 0.0.1
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/api
security:
- basic: []
- api_key: []
tags:
- name: Render
paths:
  /reports/render/csvs:
    parameters: []
    get:
      tags:
      - Render
      summary: Grafana Render Report CS Vs
      description: This API operation retrieves rendered CSV versions of Grafana reports. When invoked with a GET request to the /reports/render/csvs endpoint, it processes and returns report data in CSV (Comma-Separated Values) format, making it suitable for exporting Grafana dashboard metrics and analytics into spreadsheet applications or for further data processing. This endpoint is particularly useful for users who need to access report information in a structured, tabular format outside of the Grafana interface, enabling integration with external tools, automated data pipelines, or offline analysis workflows.
      operationId: renderReportCSVs
      parameters:
      - name: dashboards
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: title
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/zip:
              schema:
                contentMediaType: application/zip
        '204':
          description: (empty)
          headers: {}
          content:
            application/zip:
              schema:
                contentMediaType: application/zip
        '400':
          description: BadRequestError is returned when the request is invalid and it cannot be processed.
          headers: {}
          content:
            application/zip:
              schema:
                contentMediaType: application/zip
        '401':
          description: UnauthorizedError is returned when the request is not authenticated.
          headers: {}
          content:
            application/zip:
              schema:
                contentMediaType: application/zip
        '500':
          description: InternalServerError is a general error indicating something went wrong internally.
          headers: {}
          content:
            application/zip:
              schema:
                contentMediaType: application/zip
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
  /reports/render/pdfs:
    parameters: []
    get:
      tags:
      - Render
      summary: Grafana Render Report PD Fs
      description: This API operation retrieves rendered PDF versions of reports from Grafana. When invoked with a GET request to the /reports/render/pdfs endpoint, it allows users to access pre-generated or on-demand PDF renderings of Grafana reports, which typically contain dashboards, panels, and visualizations. The operation is useful for exporting report data in a portable, shareable format that can be distributed to stakeholders or archived for record-keeping purposes. Users would typically need appropriate authentication and permissions to access this endpoint, and may be able to specify parameters to control which reports are rendered or retrieved.
      operationId: renderReportPDFs
      parameters:
      - name: dashboards
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: orientation
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: layout
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: title
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: scaleFactor
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      - name: includeTables
        in: query
        description: ''
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: (empty)
          headers: {}
          content:
            application/pdf:
              schema:
                contentMediaType: application/pdf
        '400':
          description: BadRequestError is returned when the request is invalid and it cannot be processed.
          headers: {}
          content:
            application/pdf:
              schema:
                contentMediaType: application/pdf
        '401':
          description: UnauthorizedError is returned when the request is not authenticated.
          headers: {}
          content:
            application/pdf:
              schema:
                contentMediaType: application/pdf
        '500':
          description: InternalServerError is a general error indicating something went wrong internally.
          headers: {}
          content:
            application/pdf:
              schema:
                contentMediaType: application/pdf
      deprecated: false
      x-api-evangelist-processing:
        SplitPascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        WriteDescription: true
        ChooseTags: true
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header
    basic:
      type: http
      scheme: basic