Get started

ioki Reporting runs in the browser, so there is nothing to install; you open it and sign in with your ioki account. It reads the reports and aggregations that ioki Platform calculates, and lets you view, filter, chart, and export them.

This page explains who can access ioki Reporting, how to sign in, what the app header and scopes do, and the overall flow. The other pages in this section cover each part in detail.

  1. Who can access ioki Reporting
  2. Environments
  3. Signing in
  4. The consent screen
  5. The app header
  6. Scopes
  7. When no reports are available
  8. The overall flow

Who can access ioki Reporting

Access to ioki Reporting is granted by the access_reports permission. A user without this permission cannot view any reports.

To open ioki Reporting and view reports, you need a role that grants the access_reports permission. The provider-scoped roles that grant it are Basic Reporter, Extended Reporter, Provider Admin, and Provider KAM. iokians use the Internal Reporter role for internal reporting across organizations.

Basic Reporter grants access to reports. Extended Reporter adds the ability to view provider-based report rows, so an Extended Reporter sees the broader set of reports.

Environments

ioki Reporting is available in several environments. See the environment links on the Reporting index page for the staging, demo, and production addresses.

Signing in

ioki Reporting does not have its own username and password. You sign in with your ioki account through single sign-on. On the sign-in screen the app shows a Sign in with ioki action and the message “Please wait. We try to sign you in.” while it redirects you to the ioki account sign-in and back.

If your account has open consents that you have not yet accepted, ioki Reporting shows a consent screen before you can continue. The screen is titled “We need your consent” and explains that there are open consents in your account which are required to use the application. Select To your account settings to review and accept the open consents, then return to ioki Reporting.

The app header

A sticky header stays at the top of every screen. From left to right it contains:

  • The ioki logo, which links to the ioki Platform.
  • The app name, Reporting, which returns you to the start of the current scope.
  • The Scopes selector, which sets the organization context whose reports you see.
  • An environment indicator that shows which environment you are in.
  • A Feedback link.
  • An app navigation menu for moving between ioki applications.

Scopes

A scope selects the organization context whose reports you see. When your account has access to more than one organization, the Scopes selector in the header lets you switch between them, and the report and dashboard lists update to match the scope you choose. When you have access to only one organization, the header shows that organization’s name and there is nothing to switch. For details, see Navigation and scopes.

When no reports are available

If ioki Reporting cannot show you any reports, it displays a “No reports available” screen. The message depends on why:

  • When your account has no organization to report on, the screen explains that you have no access to an organization on the ioki Platform and should contact an administrator to be added to one.
  • When your account has an organization but not the reporting permission, the screen explains that you have no permission to access reports and points you to your organization’s administrators.

The overall flow

A typical session in ioki Reporting follows these steps:

  1. Sign in with your ioki account, and accept any open consents.
  2. Choose a scope for the organization you want to report on. See Navigation and scopes.
  3. Open a dashboard for an overview, or open a report to work with its data.
  4. Run a report and adjust its time range and filters.
  5. Work with the data table, view charts, and export the data.
  6. If you need help, open the documentation, FAQ, and changelog.