updateScheduledReport()

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:

Show:

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 }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"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 }
}"
}';
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

#! /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)

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/graphql',
  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

Show:

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

Parameter	Type	Required	Description
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: Feb 26, 2025
`dashboardId`	string		The unique identifier of the dashboard for which the report was created.
`description`	string		Description of the scheduled report.
`enabled`	boolean	yes	Flag indicating whether the scheduled report is enabled.
`id`	string	yes	The unique identifier of the scheduled report.
`labels`	[string]	yes	Labels attached to the scheduled report.
`layout`	`UpdateScheduledReportLayoutInput`		Layout of the scheduled report. See `UpdateScheduledReportLayoutInput`.
`name`	string		The name of the scheduled report.
`parameters`	[`UpdateScheduledReportParameterValueInput`]	yes	A list of parameter value configurations. See `UpdateScheduledReportParameterValueInput`.
`password`	string		The password used to protect any generated reports.
`recipients`	[string]		A list of recipients who should receive an email with the generated report.
`schedule`	`UpdateScheduledReportScheduleInput`		The schedule by which to run the report. See `UpdateScheduledReportScheduleInput`.
`timeIntervalFrom`	string		The start of the relative time interval for the dashboard.
`viewName`	string	yes	The 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

Parameter	Type	Required	Stability	Description
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 19, 2025
`allowedActions`	[`AssetAction`]	yes	`Preview`	Allowed asset actions. This is a preview and subject to changes. See `AssetAction`.
`createdBy`	`User`		`Long-Term`	User who created the report. See `User`.
`creationDate`	string	yes	`Long-Term`	Date when the report was created.
`dashboard`	`Dashboard`	yes	`Long-Term`	The dashboard for which the report was created. See `TEXT`.
`dashboardId`	string	yes	`Long-Term`	The unique identifier of the dashboard for which the report was created.
`description`	string	yes	`Long-Term`	Description of the scheduled report.
`enabled`	boolean	yes	`Long-Term`	Whether the scheduled report is enabled.
`id`	string	yes	`Long-Term`	The unique identifier of the scheduled report.
`isPasswordDefined`	boolean	yes	`Long-Term`	Whether a password is defined for the report.
`labels`	[string]	yes	`Long-Term`	Labels attached to the scheduled report.
`lastExecutionErrors`	[string]	yes	`Long-Term`	Last errors encountered while generating the scheduled report.
`lastExecutionWarnings`	[string]	yes	`Long-Term`	Last warnings encountered while generating the scheduled report.
`layout`	`ScheduledReportLayout`	yes	`Long-Term`	Layout of the scheduled report. See `ScheduledReportLayout`.
`name`	string	yes	`Long-Term`	The name of the scheduled report.
`parameters`	[`ParameterValue`]	yes	`Long-Term`	List of parameter value configurations. See `ParameterValue`.
`recipients`	[string]	yes	`Long-Term`	List of recipients who should receive an email with the generated report.
`resource`	string	yes	`Short-Term`	The resource identifier for this scheduled report.
`schedule`	`Schedule`	yes	`Long-Term`	The schedule by which to run the report. See `Schedule`.
`status`	string	yes	`Long-Term`	Status of the latest report execution.
`timeIntervalStart`	string		`Long-Term`	Start of the relative time interval for the dashboard.
`timeOfLastReportExecution`	long		`Long-Term`	Unix timestamp for the last report execution. The timestamp only indicates an attempt, not if it was successful.
`timeOfNextPlannedReportExecution`	long		`Long-Term`	Unix timestamp for the next planned report execution.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes