API Stability Short-Term

The exceededQueryQuotas() GraphQL query is used to determine if a user has exceeded their query quota.

For more information on query quotas, see the Query Quotas documentation page.

Syntax

Below is the syntax for the exceededQueryQuotas() query field:

graphql
exceededQueryQuotas(
     username: string!
   ): [QueryQuotaExceeded]

This query field requires only the username of the user who may have exceeded their query quota. Below is an example of this:

Raw
graphql
query {
  exceededQueryQuotas(username: "admin")
  {kind, resetsAt}
}
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 {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}"
}
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 {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}"
}
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 { ^
  exceededQueryQuotas(username: \"admin\") ^
  {kind, resetsAt} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}"
}'
    "$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 {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}";
$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 {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}"
}'''

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 {
  exceededQueryQuotas(username: \"admin\")
  {kind, resetsAt}
}"
}
);


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": {
    "exceededQueryQuotas": []
  }
}

The results don't show anything because this user didn't exceed the query quota.

Returned Datatypes

The returned datatype QueryQuotaExceeded has only a couple of parameters. They're listed here:

Table: QueryQuotaExceeded

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: Oct 2, 2024
kindQueryQuotaMeasurementKindyes Short-TermThe type of measurement for the query quota. See QueryQuotaMeasurementKind.
resetsAtlongyes Short-TermThe point at which the query quota resets.