ReportExportOut

Fields

One background report export.

15 fields

attempts · required

integer

download_url

string or null

error

string or null

expires_at · required

string (date-time)

filename

string or null

finished_at

string (date-time) or null

format · required

string

id · required

string (uuid)

params · required

object

project_id · required

string (uuid)

requested_at · required

string (date-time)

retryable · required

boolean

size_bytes

integer or null

started_at

string (date-time) or null

status · required

string

Raw schema (JSON)

{
  "description": "VIZ-607: one background report export.",
  "properties": {
    "attempts": {
      "title": "Attempts",
      "type": "integer"
    },
    "download_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Download Url"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Error"
    },
    "expires_at": {
      "format": "date-time",
      "title": "Expires At",
      "type": "string"
    },
    "filename": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Filename"
    },
    "finished_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "format": {
      "enum": [
        "pdf",
        "xlsx"
      ],
      "title": "Format",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "params": {
      "additionalProperties": true,
      "title": "Params",
      "type": "object"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "requested_at": {
      "format": "date-time",
      "title": "Requested At",
      "type": "string"
    },
    "retryable": {
      "title": "Retryable",
      "type": "boolean"
    },
    "size_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Size Bytes"
    },
    "started_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "enum": [
        "queued",
        "running",
        "completed",
        "failed"
      ],
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "format",
    "status",
    "attempts",
    "params",
    "requested_at",
    "expires_at",
    "retryable"
  ],
  "title": "ReportExportOut",
  "type": "object"
}

Used by endpoints

4 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/reports/summary/exports — List Summary Report Exports
• GET /api/v1/reports/summary/exports/{export_id} — Get Summary Report Export
• POST /api/v1/reports/summary/exports/{export_id}/retry — Retry Summary Report Export
• POST /api/v1/reports/summary/exports — Request Summary Report Export

Used by schemas

• ReportExportRequestOut

More details

• Specification: OpenAPI JSON