Files
moderne-docs/docs/user-documentation/moderne-platform/references/user-reports.md
Mike Solomon fa80be4660 Move reporting doc to reference
As it wasn't really a good fit for how-to guides
2024-12-11 09:19:40 -08:00

1.9 KiB

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

User reports

Moderne offers the following reports:

  • Usage by organization - This includes every recipe run and associated commit by every user for a specific organization.

Usage by organization

The generated report includes every recipe run and associated commit for a given organization. This report includes the recipe name, time saved, user that ran it, recipe, and various statistics of the recipe run.

If any commit was created in association with the recipe run, details of the commit are included (e.g., the type of commit or the status of the commit job).

The usage report is accessible from https://<TENANT>.moderne.io/devcenter/{organization}.

This report can be downloaded by clicking on the download button in the top-right corner of a DevCenter:

![](./assets/usage-report-download.gif)
_Downloading the usage report_

Accessing via the API

All of these reports can be accessed via the API, as well. Below is an example of how to prepare and download the usage report:

mutation firstDownloadUsageReport($until: DateTime!, $since:DateTime!, $organizationId: String) {
    downloadUsageReport(until: $until, since: $since , organizationId:$organizationId) {
        id
    }
}
{
  "since": "2024-10-29T10:15:30Z",
  "until":"2024-12-30T10:15:30Z",
  "organizationId":"my_organization_Id"
}
query secondDownloadUsageReport($id: ID!) {
    usageReportDownload(id: $id) {
        id
        state
        stateMessage
        url
        fileSize
    }
}

The output of secondDownloadUsageReport will include a URL which you can then use to download the report.