API Stability Long-Term

The enableScheduledReport() GraphQL mutation may be used to enable a scheduled report.

To disable a shceduled report, use the disableScheduledReport() mutation. To set up a new one, you can use the createScheduledReport() mutation. To change a scheduled report, you can use the updateScheduledReport() mutation. Use the deleteScheduledReport() mutation to delete a scheduled reports.

There is also the query, scheduledReport() for getting information about a scheduled report. For this query and almost all of these mutations you will need the unique identifier of the scheduled report. Click on the » link below to see how to get this.

Hide Query Example

Show Scheduled Reports Query

Syntax

Below is the syntax for the enableScheduledReport() mutation field:

graphql
enableScheduledReport(
      input: EnableScheduledReportInput!
   ): boolean

There are no special returned datatypes for this mutation field.

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  enableScheduledReport (input:
    { viewName: "humio",
      id: "uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn"
    } )
}
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" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
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" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
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" : "mutation { ^
  enableScheduledReport (input: ^
    { viewName: \"humio\", ^
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\" ^
    } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}'
    "$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 = "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}";
$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" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}'''

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" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
);


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": {
    "enableScheduledReport": true
  }
}

Given Datatype

For this input datatype, you would give the unique identifier of the scheduled report to enable, and the name of the associated view. This is described in the table here:

Table: EnableScheduledReportInput

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: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the scheduled report.
viewNamestringyes Long-TermThe name of the view of the scheduled report.