Skip to main content

ReportGenerateResponse

errorsobject[]
generated_countGenerated Countrequired
report objectrequired
created_atCreated Atrequired
created_by object
anyOf
string
description object
anyOf
string
idIdrequired
is_templateIs Template
Default value: false
layout_config object
property name*any
sections object

Present on single-report reads.

anyOf
  • Array [
  • cached_output object

    The last generated output.

    anyOf
    property name*any
    created_atCreated Atrequired
    data_scope object
    property name*any
    display_typeDisplay Type

    cards, table, narrative or grade_bar.

    Default value: narrative
    generated_at object
    anyOf
    string
    idIdrequired
    is_staleIs Stale
    Default value: true
    prompt_template object
    anyOf
    string
    report_idReport Idrequired
    section_typeSection Typerequired

    prompt_analysis, aggregate_summary or data_table.

    sort_orderSort Order
    Default value: 0
    titleTitlerequired
    updated_atUpdated Atrequired
    property name*any
  • ]
  • titleTitlerequired
    Example: Weekly narrative scorecard
    updated_atUpdated Atrequired
    workspace_idWorkspace Idrequired
    property name*any
    stale_countStale Countrequired
    property name*any
    ReportGenerateResponse
    {
    "errors": [
    {}
    ],
    "generated_count": 0,
    "report": {
    "created_at": "string",
    "created_by": "string",
    "description": "string",
    "id": "string",
    "is_template": false,
    "layout_config": {},
    "sections": [
    {
    "cached_output": {},
    "created_at": "string",
    "data_scope": {},
    "display_type": "narrative",
    "generated_at": "string",
    "id": "string",
    "is_stale": true,
    "prompt_template": "string",
    "report_id": "string",
    "section_type": "string",
    "sort_order": 0,
    "title": "string",
    "updated_at": "string"
    }
    ],
    "title": "Weekly narrative scorecard",
    "updated_at": "string",
    "workspace_id": "string"
    },
    "stale_count": 0
    }