๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The scheduledReportResultFailed() mutation records a failed scheduled report generation attempt in LogScale. Call this mutation after a report generation job fails. Pass a list of error and warning entries that describe what went wrong. LogScale stores these entries against the report run for retrieval and display.

Each entry specifies a message and a type: either Error or Warning. Errors indicate conditions that caused the run to fail. Warnings indicate non-fatal conditions encountered during the run. Both are passed through the same reportErrors list.

Syntax

graphql
scheduledReportResultFailed(
      input: ScheduledReportResultFailedInput!
   ): Boolean!

The input argument accepts a ScheduledReportResultFailedInput! object. Provide a list of error and warning entries from the failed run. The mutation returns Boolean!.

Input parameters

The ScheduledReportResultFailedInput! object requires the reportErrors field: a list of ReportErrorInput entries. Each entry requires an errorMessage string and an errorType string. Set errorType to Error for failures, or Warning for non-fatal conditions. Pass all errors and warnings in this list.

Table: ScheduledReportResultFailedInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
reportErrorsReportErrorInputyesย Long-Termย A list of resulting errors and warnings. See ReportErrorInput.

Example

Raw
graphql
mutation {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: "401", errorType: "Warning"}, 
                      { errorMessage: "501", errorType: "Error"} ] 
    }
  )
}
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 {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}"
}
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 {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}"
}
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 { ^
  scheduledReportResultFailed( input: ^
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"},  ^
                      { errorMessage: \"501\", errorType: \"Error\"} ]  ^
    } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}"
}'
    "$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 {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}";
$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 {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}"
}'''

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 {
  scheduledReportResultFailed( input:
    { reportErrors: [ { errorMessage: \"401\", errorType: \"Warning\"}, 
                      { errorMessage: \"501\", errorType: \"Error\"} ] 
    }
  )
}"
}
);


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

Returned values

The mutation returns Boolean!. A value of true indicates LogScale recorded the failure result.