Queries GraphQL API

Queries are the starting point to begin consulting information as you use a query to request information from a database. The GraphQL API relies on queries to fetch values and send the requested data as a response with a similar format in a JSON file.

The use of queries enables requesting and fetching specific data. This means you can get a response to your request even with a small query if you don’t want to see data that isn’t essential at that moment. Using queries also means you get faster responses, as the GraphQL API doesn’t need to fetch unnecessary amount of data.

By using queries, your requests and responses also become more organized. Due to GraphQL’s ability to adapt, you can make several calls to the API and still receive only the data you requested in an organized JSON result.

You can use queries for two types of data:

• Raw, using the Real-Time Events GraphQL API.
• Aggregated, using the Real-Time Metrics GraphQL API.

For each type of data, you’ll query with different GraphQL datasets.

Raw data

Raw data exhibit your event records without any further processing. They provide detailed information and are helpful when performing deep-dive investigations.

Here’s an example of a raw Real-Time Events GraphQL query:

And the response to the query:

To query raw data, it’s mandatory to inform:

• A time range interval for all datasets, using either tsRange or tsGt + tsLt.
• Which consulted data should be exhibited. On the presented example, the ts, remoteAddress, requestUri, and stacktrace fields were used.

For example, to perform a NOT LIKE query, use the not operator with the Like or Ilike operators to filter out entries that match a certain text. Here’s an example:

Aggregated data

Aggregated data are a type of structured data that have been clustered. They go through modifications to allow a better analytic processing seeking a segmented analysis, making it easier to visualize even great amount of data over a larger period of time.

Here’s an example of an aggregated Real-Time Metrics GraphQL query:

And the response to the query:

To query aggregated data, it’s mandatory to inform:

• A time range interval for all datasets, using either tsRange or tsGt + tsLt.
• The fields whose information you want to group, using groupBy.
• Which consulted data should be shown. On the presented example, the ts and sum fields were used, in which sum represents the response of the requestTime aggregation.

There are also a few options that you must inform through the aggregate field in your query:

Find more information and examples in the How to query aggregated data with GraphQL API guide.

You can run a request with one of each of the available options: count, sum, max, min, avg, and rate, as long as each option is only used once and each operator aggregates only one dataset field at a time. See the following example:

With the aggregated model, you’ll receive data according to a time range defined through an adaptive resolver. There are three possible intervals to fetch your results: minute, hour, and day.

Financial data

Financial data exhibit information of two types: accounted data and billed data.

Here’s an example of a financial data Accounting GraphQL query:

And the response to the query:

To query financial data, it’s mandatory to inform:

• Which consulted data should be exhibited. On the presented example, the accounted, clientId, metricSlug, periodFrom, and periodTo fields were used.

Different from a raw and an aggregated query, you’ll use the periodFrom and periodTo fields to filter a time range.

Usage data

Usage data exhibit information as accounted data.

Here’s an example of usage data for Image Processor using Consumption GraphQL API query:

And the response to the query:

To query usage data, it’s mandatory to inform:

Which consulted data should be exhibited. On the presented example, the accounted, clientId, workloadId, productId, and metricName were used.

Operators

Operators are special keys that allow you to customize your query to perform from basic to more complex logical comparisons. You can use them for both the Real-Time Metrics GraphQL API and the Real-Time Events GraphQL API.

Depending on the operator you use, you’ll change the condition you’re querying for and receive different results. The following operators can be used with GraphQL:

If you’re using the Like and Ilike operators, you must also pass the identifier % inside the field in the position you want to use:

Here are a few examples of fields with an operator:

Depending on the type of field of a dataset you’re querying for, you’ll get to use different operators: