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

# Get a report delivery run

In preview: ask Cube support to enable it. Poll it after starting a run: `status` stays `running` until the run finishes.


## OpenAPI

````yaml /api-reference/api.yaml get /api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs/{runId}
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Databricks Metric View Publication
  - name: Databricks Metric View Integration
  - name: Snowflake Semantic View Sync
  - name: Folders
  - name: Reports
  - name: External Documents
  - name: Workbooks
  - name: Workbook Promotions
  - name: Dashboard Exports
  - name: Notifications
  - name: Scheduled Tasks
  - name: Workspace
  - name: Agents
  - name: Users
  - name: Users Admin
  - name: API Keys
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
  - name: Usage Analytics
  - name: OpenAPI Spec
  - name: Report Deliveries
paths:
  /api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs/{runId}:
    get:
      tags:
        - Report Deliveries
      summary: Get a report delivery run
      operationId: getReportDeliveryRun
      parameters:
        - in: path
          name: deploymentId
          required: true
          schema:
            type: integer
          description: Numeric id of the deployment that owns the delivery.
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: Numeric id of the report delivery.
        - in: path
          name: runId
          required: true
          schema:
            type: integer
          description: Numeric id of the run, as returned when it was started.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDeliveryRunResponse'
          description: ''
components:
  schemas:
    ReportDeliveryRunResponse:
      properties:
        cellsWritten:
          oneOf:
            - type: integer
            - type: 'null'
          description: Cells written, headers included.
        deliveryId:
          type: integer
        error:
          oneOf:
            - $ref: '#/components/schemas/ReportDeliveryRunFailure'
            - type: 'null'
          description: '`null` unless the run failed.'
        finishedAt:
          oneOf:
            - format: date-time
              type: string
            - type: 'null'
          description: '`null` while the run is going.'
        id:
          type: integer
        rowsWritten:
          oneOf:
            - type: integer
            - type: 'null'
          description: Result rows written, headers excluded.
        startedAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/ReportDeliveryRunResponseStatus'
        trigger:
          $ref: '#/components/schemas/ReportDeliveryRunResponseTrigger'
      required:
        - id
        - deliveryId
        - status
        - trigger
        - startedAt
      type: object
    ReportDeliveryRunFailure:
      properties:
        code:
          description: >-
            Why the run failed, e.g. `collision`, `shape-changed`,
            `query-failed` or `reconnect`.
          type: string
        text:
          description: >-
            A sentence for a person to read; never raw Google or warehouse
            output.
          type: string
      required:
        - code
        - text
      type: object
    ReportDeliveryRunResponseStatus:
      enum:
        - running
        - succeeded
        - unchanged
        - failed
        - skipped
        - missed
      type: string
    ReportDeliveryRunResponseTrigger:
      enum:
        - manual
        - schedule
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````

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