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: [ScheduledReport]!

There is no input for this query field, just a return datatype. Below is an example using it:

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": 123abc,
      "name": "my_report",
      "enabled": true,
    }
  }
}

Returned Datatype

For ScheduledReport, there are several parameters. They're listed here along with descriptions 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.