API Stability Long-Term

The updateScheduledReport() GraphQL mutation may be used to update a scheduled report. Only the given property values are updated.

Syntax

Below is the syntax for the updateScheduledReport() mutation field:

graphql
updateScheduledReport(
      input: UpdateScheduledReportInput!
   ): ScheduledReport!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateScheduledReport(input:
       { id: "abc123",
         viewName: "humio",
         schedule: {cronExpression: "H 2 * * *", 
                    timeZone: "UTC+00:00", 
                    startDate: 1729781206587},
         recipients: ["bob@company.com", "ted@company.com"]
      } )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateScheduledReport(input: ^
       { id: \"abc123\", ^
         viewName: \"humio\", ^
         schedule: {cronExpression: \"H 2 * * *\",  ^
                    timeZone: \"UTC+00:00\",  ^
                    startDate: 1729781206587}, ^
         recipients: [\"bob@company.com\", \"ted@company.com\"] ^
      } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateScheduledReport(input:
       { id: \"abc123\",
         viewName: \"humio\",
         schedule: {cronExpression: \"H 2 * * *\", 
                    timeZone: \"UTC+00:00\", 
                    startDate: 1729781206587},
         recipients: [\"bob@company.com\", \"ted@company.com\"]
      } )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateScheduledReport": {
      "id": "abc123"
    }
  }
}

Given Datatypes

For UpdateScheduledReportInput, there are several parameters. Below is a list of them along with a description of each:

Table: UpdateScheduledReportInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Jul 25, 2025
dashboardIdstring  Long-TermThe unique identifier of the dashboard for which the report was created.
descriptionstring  Long-TermDescription of the scheduled report.
enabledboolean  Long-TermFlag indicating whether the scheduled report is enabled.
idstringyes Long-TermThe unique identifier of the scheduled report.
labels[string]  Long-TermLabels attached to the scheduled report.
layoutUpdateScheduledReportLayoutInput  Long-TermLayout of the scheduled report. See UpdateScheduledReportLayoutInput.
namestring  Long-TermThe name of the scheduled report.
parameters[UpdateScheduledReportParameterValueInput]  Long-TermA list of parameter value configurations. See UpdateScheduledReportParameterValueInput.
passwordstring  Long-TermThe password used to protect any generated reports.
recipients[string]  Long-TermA list of recipients who should receive an email with the generated report.
scheduleUpdateScheduledReportScheduleInput  Long-TermThe schedule by which to run the report. See UpdateScheduledReportScheduleInput.
timeIntervalFromstring  Long-TermThe start of the relative time interval for the dashboard.
viewNamestringyes Long-TermThe name of the view of the scheduled report.

Returned Datatypes

The returned datatype ScheduledReport has several parameters. Below is a list of them along with a description of each:

Table: ScheduledReport

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 21, 2025
allowedActions[AssetAction]yes Short-TermAllowed asset actions. This is a preview and subject to changes. See AssetAction .
createdByUser  Long-TermUser who created the report. See User.
creationDatestringyes Long-TermDate when the report was created.
dashboardDashboardyes Long-TermThe dashboard for which the report was created. See Dashboard.
dashboardIdstringyes Long-TermThe unique identifier of the dashboard for which the report was created.
descriptionstringyes Long-TermDescription of the scheduled report.
enabledbooleanyes Long-TermWhether the scheduled report is enabled.
idstringyes Long-TermThe unique identifier of the scheduled report.
isPasswordDefinedbooleanyes Long-TermWhether a password is defined for the report.
labels[string]yes Long-TermLabels attached to the scheduled report.
lastExecutionErrors[string]yes Long-TermLast errors encountered while generating the scheduled report.
lastExecutionWarnings[string]yes Long-TermLast warnings encountered while generating the scheduled report.
layoutScheduledReportLayoutyes Long-TermLayout of the scheduled report. See ScheduledReportLayout.
namestringyes Long-TermThe name of the scheduled report.
parameters[ParameterValue]yes Long-TermList of parameter value configurations. See ParameterValue.
recipients[string]yes Long-TermList of recipients who should receive an email with the generated report.
resourcestringyes Short-TermThe resource identifier for this scheduled report.
scheduleScheduleyes Long-TermThe schedule by which to run the report. See Schedule.
statusstringyes Long-TermStatus of the latest report execution.
timeIntervalStartstring  Long-TermStart of the relative time interval for the dashboard.
timeOfLastReportExecutionlong  Long-TermUnix timestamp for the last report execution. The timestamp only indicates an attempt, not if it was successful.
timeOfNextPlannedReportExecutionlong  Long-TermUnix timestamp for the next planned report execution.