Skip to main content
Version: Next

ReportScheduleRestApi.get

activebooleannullable
chart object
idinteger
slice_namestringnullable

Possible values: <= 250 characters

viz_typestringnullable

Possible values: <= 250 characters

context_markdownstringnullable
creation_methodstringnullable

Possible values: <= 255 characters

crontabstringrequired

Possible values: <= 1000 characters

custom_widthintegernullable
dashboard object
dashboard_titlestringnullable

Possible values: <= 500 characters

idinteger
database object
database_namestringrequired

Possible values: <= 250 characters

idinteger
descriptionstringnullable
editors object[]
  • Array [
  • idinteger
    labelstringrequired

    Possible values: <= 255 characters

    typeintegerrequired
  • ]
  • email_subjectstringnullable

    Possible values: <= 255 characters

    extra
    force_screenshotbooleannullable
    grace_periodintegernullable
    idinteger
    include_ctabooleannullable
    last_eval_dttmstring<date-time>nullable
    last_statestringnullable

    Possible values: <= 50 characters

    last_valuenumbernullable
    last_value_row_jsonstringnullable
    log_retentionintegernullable
    namestringrequired

    Possible values: <= 150 characters

    recipients object[]required
  • Array [
  • idinteger
    recipient_config_jsonstringnullable
    typestringrequired

    Possible values: <= 50 characters

  • ]
  • report_formatstringnullable

    Possible values: <= 50 characters

    retry_max_attemptsinteger
    retry_notify_ownersboolean
    retry_notify_recipientsboolean
    retry_on_failureboolean
    send_failed_reportsboolean
    sqlstringnullable
    timezonestring

    Possible values: <= 100 characters

    typestringrequired

    Possible values: <= 50 characters

    validator_config_jsonstringnullable
    validator_typestringnullable

    Possible values: <= 100 characters

    working_timeoutintegernullable
    ReportScheduleRestApi.get
    {
    "active": true,
    "chart": {
    "id": 0,
    "slice_name": "string",
    "viz_type": "string"
    },
    "context_markdown": "string",
    "creation_method": "string",
    "crontab": "string",
    "custom_width": 0,
    "dashboard": {
    "dashboard_title": "string",
    "id": 0
    },
    "database": {
    "database_name": "string",
    "id": 0
    },
    "description": "string",
    "editors": [
    {
    "id": 0,
    "label": "string",
    "type": 0
    }
    ],
    "email_subject": "string",
    "force_screenshot": true,
    "grace_period": 0,
    "id": 0,
    "include_cta": true,
    "last_eval_dttm": "2024-07-29T15:51:28.071Z",
    "last_state": "string",
    "last_value": 0,
    "last_value_row_json": "string",
    "log_retention": 0,
    "name": "string",
    "recipients": [
    {
    "id": 0,
    "recipient_config_json": "string",
    "type": "string"
    }
    ],
    "report_format": "string",
    "retry_max_attempts": 0,
    "retry_notify_owners": true,
    "retry_notify_recipients": true,
    "retry_on_failure": true,
    "send_failed_reports": true,
    "sql": "string",
    "timezone": "string",
    "type": "string",
    "validator_config_json": "string",
    "validator_type": "string",
    "working_timeout": 0
    }