For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Support Center
OverviewAPIResources
OverviewAPIResources
    • Release Notes
      • Admin Dashboards Overview
      • Query Builder
      • Account Actions
      • User Actions
      • Reports
Support Center
LogoLogo
On this page
  • Query Builder Interface
  • Query Builder Options
  • Working with Query Results
  • Select Entities
  • Operate On a Selection
  • Choose an Entity View
  • Advanced Query Techniques
  • Make an Aggregate Query
  • Find Recently Created Entities
  • Query Management
  • View Recent Query History
  • Saving a Query
Admin Dashboards

Query Builder

Was this page helpful?
Previous

Account Actions

Next
Built with

Master the Query Builder interface to efficiently search, filter, and manage your organization’s data with powerful query capabilities.

Query Builder Interface

The Query Builder is the main point of interaction for finding data related to your organization’s users or accounts. You can create queries over repositories and view results with comprehensive filtering and search capabilities.

Query Builder Options

Query Type
  • Regular: Normal queries over records in the chosen repository
  • Aggregate: Counting functions such as the sum of all accounts that meet the provided ‘Where’ clause
Repository Name

Choose one of any entity type to build a query around that repository. This selection controls the type of result and available parameters.

Ids

A comma-separated list of entity IDs to look up directly. Leave this blank if you don’t want to search by entity ID.

Master Ids

A comma-separated list of master entity IDs. This function is used for selecting entities of the Repository type that are related to a master entity (or entities). The master entity type is different for different base entity types.

Select
  • Choose which fields to display in the result
  • The order you list the fields is important - this will affect the order that the columns are generated
  • You can automatically generate this value by clicking the ‘DEFAULT GRID’ button
Where
  • Filter the result using any field name from the entity type selected
  • Supports >, >=, <, <=, ==, OR, and AND logical operators
  • Supports isNull(fieldName) null check function
  • Supports the like operator used with regex like so - "(?iu).*Search_String_Here*"
  • Timestamps are in UTC and have the following format: yyyy-mm-ddThh:mm:ss.nnnZ; midnight Aug 1st would be 2023-08-01T00:00:00.000Z
Order By
  • Choose the field to order by. Strings will use alphabetical comparison
  • Be cautious not to use an object as an Order By index. For example, ordering trading permissions by account won’t work, but ordering trading permissions by account.id will work
Sort Direction

Ascending or Descending.

Limit

Limits the number of selected entities. The larger the number, the longer it will take to complete the search or bulk ops over the set.

Recent Period By

Choose a field from the entity to find if this field was changed within Recent Seconds time period. Useful to find recent records.

Recent Seconds

The number of seconds by which to measure the Recent Period By field.

Working with Query Results

Select Entities

To select an entity, click its checkbox. You can select multiple entities, but realize that the list of allowed actions will change based on whether you have a single or multiple selections.

Operate On a Selection

You can choose ‘ACTIONS’ when you have one or more entities selected. The available actions will change based on whether your selection is for a single or multiple entities.

The Admin Dashboard services both Partner Admins and NT Admins - some of the listed actions will not be available for Partner Admins. This is completely normal and expected behavior. We have constructed many powerful and high level functions for Partner Admins to interact with our system, however, so you will not be missing out!

Choose an Entity View

You can choose a view for any entity in the result list:

  • Eye Icon: View the entity data card (and in some cases, edit the entity)
  • Layout Button: View a dashboard for the selected entity

Advanced Query Techniques

Make an Aggregate Query

The very first setting, Query Type, allows you to change from a regular filter over entities to an aggregation function. The most common use for this is finding the count of entities that satisfy a query.

Example: Count how many accounts you have created that still have active trading permissions. These will be non-failed accounts if you are using the standard method of revoking accounts on evaluation failure.

Find Recently Created Entities

You can use the Recent Period By and Recent Seconds fields to find entities created within a recent time period. This is useful for finding accounts with timestamps from within the last hour or other recent timeframes.

Query Management

View Recent Query History

You can view recent queries by choosing History from the top-bar in the Query Builder view. This allows you to:

  • Re-run any of the listed queries by clicking ‘RUN’
  • View query details (but not run them) using the vertical ellipsis

Saving a Query

You can save a query for later use. This can be useful when you perform an action often, or to speed up response time for simple actions. You can even treat them as templates and replace the meaningful values as necessary.

To save a query:

  1. Create your query
  2. Instead of running it, click the vertical ellipsis and select “Save Query”
  3. Provide a Query Name and Description
  4. Click ‘SAVE’

To access saved queries:

  1. Navigate to the Saved tab from the top bar
  2. You can either ‘RUN’ the query outright, or view it by selecting the vertical ellipsis
  3. You can also ‘Delete’ queries from the vertical ellipsis menu