The scheduledReport() GraphQL query is used to
get scheduled report information using a scheduled report access
token.
Below is the syntax for the scheduledReport()
query field:
scheduledReport : LimitedScheduledReport!
Below is an example using this query field:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw query ScheduledReport {
searchDomain( name : "humio-usage" ) {
scheduledReport( id : "81DhQYNRE0N4bNBjWLXNo6KVtNquPeza" ) {
name, status, createdBy {
id, username
}
}
}
}
Mac OS or Linux (curl) curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}
EOF
Mac OS or Linux (curl) One-line curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}
EOF
Windows Cmd and curl curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
-H "Authorization: Bearer $TOKEN" ^
-H "Content-Type: application/json" ^
-d @'{"query" : "query ScheduledReport { ^
searchDomain(name:\"humio-usage\") { ^
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") { ^
name, status, createdBy { ^
id, username ^
} ^
} ^
} ^
}" ^
} '
Windows Powershell and curl curl.exe -X POST
-H "Authorization: Bearer $TOKEN "
-H "Content-Type: application/json"
-d '{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}'
"$YOUR_LOGSCALE_URL /graphql"
Perl
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}' ;
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
import requests
url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}'''
resp = requests.post(url,
data = mydata,
headers = {
"Authorization" : "Bearer $TOKEN" ,
"Content-Type" : "application/json"
}
)
print (resp.text)
Node.js const https = require ('https' );
const data = JSON .stringify (
{"query" : "query ScheduledReport {
searchDomain(name:\"humio-usage\") {
scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
name, status, createdBy {
id, username
}
}
}
}"
}
);
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 ();
For LimitedScheduledReport , there are several
parameters. They're listed here along with descriptions of each:
Table: LimitedScheduledReport
Parameter Type Required Default 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 26, 2025 dashboardDisplayName
string yes Long-Term
The display name of the dashboard referenced by the report. dashboardName
string yes Long-Term
The name of the dashboard referenced by the report. dashboardSections
[string] yes Long-Term
The sections of the dashboard referenced by the report. dashboardSharedTimeintegererval
SharedDashboardTimeInterval
yes Long-Term
The shared time interval of the dashboard referenced by the report. See SharedDashboardTimeInterval
dashboardWidgets
[Widget
] yes Long-Term
The widgets of the dashboard referenced by the report. description
string yes Long-Term
The description of the scheduled report. id
string yes Long-Term
The unique identifier of the scheduled report. layout
ScheduledReportLayout
yes Long-Term
The layout of the scheduled report. See ScheduledReportLayout
. name
string yes Long-Term
The name of the scheduled report. parameters
[ParameterValue
] yes Long-Term
A list of parameter value configurations. See ParameterValue
. repoOrViewName
RepoOrViewName
yes Long-Term
The name of the repository or view queries are executed against. RepoOrViewName
is a scalar. resource
string yes Long-Term
The resource identifier for this scheduled report. timeZone
string yes Long-Term
The timezone of the schedule (e.g., UTC, Europe/Copenhagen).