API Stability Short-Term

The queryQuotaUserSettings() GraphQL query returns the query quota settings for a given user.

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

Syntax

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

graphql
queryQuotaUserSettings(
     username: string
   ): [QueryQuotaUserSettings]!

There's only one input, the username , and it's not required. If omitted, the query returns the Query Quota Settings for all users.

Here's an example of how this query field might be used:

Raw
graphql
query {
  queryQuotaUserSettings(username: "bob@company.com") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}
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 {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}"
}
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 {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}"
}
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 { ^
  queryQuotaUserSettings(username: \"bob@company.com\")  ^
  { settings { interval, measurementKind,  ^
               value, valueKind, source } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}"
}'
    "$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 {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}";
$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 {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}"
}'''

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 {
  queryQuotaUserSettings(username: \"bob@company.com\") 
  { settings { interval, measurementKind, 
               value, valueKind, source } }
}"
}
);


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

Returned Datatypes

QueryQuotaUserSettings has a couple of parameters and sub-parameters. Below is a list of them, along with links to the sub-parameters:

Table: QueryQuotaUserSettings

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
settings[QueryQuotaIntervalSetting]yes Short-TermList of the settings that apply. See QueryQuotaIntervalSetting.
usernamestringyes Short-TermUsername of the user for which these Query Quota settings apply.