Create graph powered reports in seconds with Ardoq’s Report Builder. Choose between Advanced Search and Gremlin Search to query one or more workspaces at once. Next, invite key stakeholders to your report and assign them Administrator, Writing or Read-only permission.

Once your report is ready, add it to a dashboard to visualize your data and communicate critical metrics and actionable insights.

If you previously had saved Advanced and Gremlin searches, these are now converted into reports. Learn more about the migration of saved searches into reports here.

Table of contents:


What Is A Report

A report in Ardoq is where you can:

  • Build queries using the Report Builder to:

    • Find components or references of a certain type or with specific field values using Advanced Search.

    • Analyze the relationships between the components in your graph data model, and their properties using Gremlin Graph Search.

  • Invite key stakeholders to a report and keep control of who has access to the data

  • Assign dedicated report permissions and manage what users can do

  • Calculate aggregated data in just a few clicks

With reports, you can decide what data to share and with who, and eliminate data silos. Access to the queried workspaces (having Administrator, Writing or Read-only workspace permissions) is not required to see the workspace data the report is based on.

How To Create A Report

To create a report, make sure you have the Administrator or Writer user role.

1. Open the Report Builder.

You can open the Report Builder from two places:

  • From the “Home” page, click on the “Create New” button located at the top right corner. Next, choose “Report”.

  • From Analytics > Reports Overview. Select "Create New" at the top right corner of the screen.

2. Fill out each card in the Report Builder

  • Name report. Give a name to your report so you can save it when you are ready.

Ardoq Report Builder
  • Data selection

    1. Select the type of search you want to use. Choose between:

      • Advanced Search: Find components or references of a certain type or with specific field values.

      • Gremlin Search: Analyze the relationships between the components in your model and their properties with graph traversal language Gremlin.

    2. Define the workspace(s) that you want to analyze.

      NB: If you are editing a converted report, you won't be able to save any changes until at least one workspace is defined in this step. Learn more about converted reports and the migration here.

    3. Build a query using the Advanced Search query builder or the Gremlin Search query builder.

      Ardoq Report Builder

      Take a look at the “Gremlin Graph Search Examples” KB article and get useful tips to start solving business questions with Ardoq Graph Search.

    4. Click "Search" to see the total results your query returned. It shows right below the "Search" button. To see which fields are available for the returned components and references, click on "Preview search results".

  • Data presentation

    Use the dropdown table controls to customize the report table.

    • Select and arrange columns in your preferred order

    • Select default column to sort by and whether in ascending or descending order

    • Select default aggregate for columns with a numerical value. Choose between:

      • Minimum: Displays the lowest value gathered for the relevant numerical field.

      • Maximum: Displays the highest value gathered for the relevant numerical field.

      • Average: Calculates the average value for the relevant numerical field.

      • Sum: Adds up all the values gathered for the relevant numerical field.

      • Count: Enumerates the total number of values gathered for the relevant numerical field.

    Ardoq Report Builder Data Presentation

    Click "Preview report" to see how your report will look like with the selected columns, default sorting, and aggregate applied.

  • Report Permissions

    Lastly, invite key stakeholders to your report and grant them the Administrator, Writing, or Read-only permission. Add Permission Groups to speed up the invite process or enter the name or email address of individual users.

    👉 See the Report Permissions section below to know what each report permission enables users to do.

3. Save your report.

Click on the “Save” button at the top right corner of your screen to save your report and share it with the people you added in the previous step.

4. Take your next step.

From here, you can either view your report in the Report Reader or go back to the Home page to see an overview of your reports.

Report Permissions

Report permissions work together with the user roles to help manage what users can do in a given report.

Ardoq user roles and report permissions

In some cases, the report permission will be pre-defined and won't be possible to change it:

  • Users with the Administrator user role are automatically granted the Administrator report permission. All users with the Administrator user role can access all reports whether they are added to it or not. Their report permission can't be changed.

  • Users with the Writer user role can be granted the Administrator, Writing, or Read-only report permission.

  • Users with the Reader user role are automatically granted the Read-only report permission. Their report permission can't be changed.

Report permissions and their rights:

  • Administrator report permission: Users with admin report permission are able to perform the following actions provided they at least have read-only permissions on the workspaces the report queries.

    • Change the name of the report

    • Update the type of data source

    • Modify the workspace or survey to run the search on

    • Edit the report query

    • Display fields and aggregates

    • Invite or remove users from the report

    • Update report permissions

    • Delete the report

  • Writing report permission: Users with the Writing report permission are able to do the following actions provided they at least have read-only permission on the underlying workspace(s):

    • Change the name of the report

    • Update the type of data source

    • Modify the workspace or survey to run the search on provided they at least have read access to the workspaces or surveys defined in the report

    • Edit the report query provided the user at least has read access to the underlying workspace(s)

    • Display fields and aggregates

  • Read-only report permission: Users with the Read-only report permission can only see the results of your query. The report loads in core Ardoq's Report Reader

Reports permissions enable you to:

  • Take control of your data.

    • Decide what workspace or survey data to share in your report

    • Invite team members to the report

    • Assign admin, writer or read-only report permissions

  • Reveal underlying data regardless of your workspace permissions, understand the fine details and:

    • Confidently make informed business decisions

    • Increase trust of analytics

    • Get stakeholder buy-in for your planned changes

    • Answer critical business questions

    • Inspect your data and spot incorrect values

Report Reader

Use the Report Reader to analyze your search results in a more comfortable way. You can access it:

  • Right after saving a report

  • When drilling down a dashboard widget

  • When opening a report

Ardoq Report Reader

Report Overview

To see a full list of your reports, navigate to Analytics > Reports Overview.

Ardoq Report Overview

Alternatively, click on the “Home” icon on the left side navigation bar and select “Reports”. This will filter the asset manager in the Home page to show only reports.

Ardoq Report Overview

From here, you can invite users to multiple reports at once, assign them a report permission, and delete several reports simultaneously.

If you have any questions, reach out via our website or by using the in-app chat. 💬 We're happy to help.

Did this answer your question?