API Stability Long-Term

The scheduledReport() GraphQL query is used to get scheduled report information using a scheduled report access token.

Syntax

Below is the syntax for the scheduledReport() query field:

graphql
scheduledReport: LimitedScheduledReport!

Below is an example using this query field:

Show:
graphql
query ScheduledReport {
  searchDomain(name:"humio-usage") {
    scheduledReport(id:"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza") {
      name, status, createdBy {
        id, username
      }
    }
  }
}

Returned Datatype

For LimitedScheduledReport, there are several parameters. They're listed here along with descriptions of each:

Table: LimitedScheduledReport

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Mar 26, 2025
dashboardDisplayNamestringyes Long-TermThe display name of the dashboard referenced by the report.
dashboardNamestringyes Long-TermThe name of the dashboard referenced by the report.
dashboardSections[string]yes Long-TermThe sections of the dashboard referenced by the report.
dashboardSharedTimeintegerervalSharedDashboardTimeIntervalyes Long-TermThe shared time interval of the dashboard referenced by the report. See SharedDashboardTimeInterval
dashboardWidgets[Widget]yes Long-TermThe widgets of the dashboard referenced by the report.
descriptionstringyes Long-TermThe description of the scheduled report.
idstringyes Long-TermThe unique identifier of the scheduled report.
layoutScheduledReportLayoutyes Long-TermThe layout of the scheduled report. See ScheduledReportLayout.
namestringyes Long-TermThe name of the scheduled report.
parameters[ParameterValue]yes Long-TermA list of parameter value configurations. See ParameterValue.
repoOrViewNameRepoOrViewNameyes Long-TermThe name of the repository or view queries are executed against. RepoOrViewName is a scalar.
resourcestringyes Long-TermThe resource identifier for this scheduled report.
timeZonestringyes Long-TermThe timezone of the schedule (e.g., UTC, Europe/Copenhagen).