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: LimitedScheduledReport!

Below is an example using this query field:

Raw
graphql
query ScheduledReport {
  searchDomain(name:"humio-usage") {
    scheduledReport(id:"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza") {
      name, status, createdBy {
        id, username
      }
    }
  }
}
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 {
  searchDomain(name:\"humio-usage\") {
    scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
      name, status, createdBy {
        id, username
      }
    }
  }
}"
}
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 {
  searchDomain(name:\"humio-usage\") {
    scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") {
      name, status, createdBy {
        id, username
      }
    }
  }
}"
}
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 { ^
  searchDomain(name:\"humio-usage\") { ^
    scheduledReport(id:\"81DhQYNRE0N4bNBjWLXNo6KVtNquPeza\") { ^
      name, status, createdBy { ^
        id, username ^
      } ^
    } ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
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
perl
#!/usr/bin/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
python
#! /usr/local/bin/python3

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
javascript
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();

Returned Datatype

For LimitedScheduledReport, there are several parameters. They're listed here along with descriptions of each:

Table: LimitedScheduledReport

ParameterTypeRequiredDefaultDescription
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: Sep 26, 2024
dashboardDisplayNamestringyes The display name of the dashboard referenced by the report.
dashboardNamestringyes The name of the dashboard referenced by the report.
dashboardSections[string]yes The sections of the dashboard referenced by the report.
dashboardSharedTimeintegerervalSharedDashboardTimeIntervalyes The shared time interval of the dashboard referenced by the report. See SharedDashboardTimeInterval
dashboardWidgets[Widget]yes The widgets of the dashboard referenced by the report.
descriptionstringyes The description of the scheduled report.
idstringyes The unique identifier of the scheduled report.
layoutScheduledReportLayoutyes The layout of the scheduled report. See ScheduledReportLayout.
namestringyes The name of the scheduled report.
parameters[ParameterValue]yes A list of parameter value configurations. See ParameterValue.
repoOrViewNameRepoOrViewNameyes The name of the repository or view queries are executed against. RepoOrViewName is a scalar.
timeZonestringyes The timezone of the schedule (e.g., UTC, Europe/Copenhagen).