Summary

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

Hide Query Example

Show Scheduled Reports Query

API Stability Long-Term

Syntax

graphql
scheduledReport: [ScheduledReport]!

There is no input for this query field. For the results, you can get the name of the related dashboard, the schedule for running the report, and the status for the last execution. See the Returned Values section for more possibilities.

Example

Raw
graphql
query{
  scheduledReport {
   id, name, enabled
  }
}
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" : "query{
  scheduledReport {
   id, name, enabled
  }
}"
}
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" : "query{
  scheduledReport {
   id, name, enabled
  }
}"
}
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" : "query{ ^
  scheduledReport { ^
   id, name, enabled ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query{
  scheduledReport {
   id, name, enabled
  }
}"
}'
    "$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 = "query{
  scheduledReport {
   id, name, enabled
  }
}";
$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" : "query{
  scheduledReport {
   id, name, enabled
  }
}"
}'''

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" : "query{
  scheduledReport {
   id, name, enabled
  }
}"
}
);


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": {
    "scheduledReport": {
      "id": abc123,
      "name": "my_report",
      "enabled": true,
    }
  }
}

Returned Values

For the results, you can get the name of the related dashboard, the schedule for running the report, and the status for the last execution. The table below lists the choices:

Table: ScheduledReport Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Oct 12, 2026
allowedActionsAssetActionyes Short-TermAllowed asset actions. This is a preview and subject to changes. See AssetAction .
createdByUser  DeprecatedUser who created the report. See User. This field is deprecated and will be removed at the earliest in version 1.306 It's replaced by createdInfo. (deprecated in 1.306)
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the scheduled report. See AssetCommitMetadata. (added in 1.253)
creationDateStringyes DeprecatedThe date when the report was created. This field is deprecated and will be removed at the earliest in version 1.306 It's replaced by createdInfo. (deprecated in 1.306)
dashboardDashboard  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.
labelsStringyes Long-TermLabels attached to the scheduled report.
lastExecutionErrorsStringyes Long-TermLast errors encountered while generating the scheduled report.
lastExecutionWarningsStringyes 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.
packagePackageInstallation  Long-TermStability: Long-term
packageIdVersionedPackageSpecifier  Long-TermStability: Long-term
parametersParameterValueyes Long-TermList of parameter value configurations. See ParameterValue.
recipientsStringyes 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.
timeOfLastExecutionStartLong  Long-TermUnix timestamp for when the last execution was sent to the render service for generation. Stability: Long-term
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.
yamlTemplateYAMLyes PreviewA YAML formatted string that describes the scheduled report template. Stability: Preview