Print this page
In this topic
You can use the sample queries in this topic as a starting point to create queries for common reporting tasks.
Run the queries in the API explorer.
For information about how to import data from the API explorer into Microsoft Excel, see Integrate Microsoft Excel with the Ringtail Connect API.
Note: GraphQL syntax is case-sensitive.
To generate a report of all enabled users with their last login date, run the following query.
query { users(disabled: false, deleted: false) { fullName userName email lastLogin } }
To generate a report of licensed users by organization, run the following query.
query { users(disabled:false, licenses: {comparison: GreaterThanOrEqualTo, value: 1}) { fullName userName email companyName licenses disabled organizations { name } } }
You can request the data available in the Portal Management Reports section of Ringtail. Portal management reports include the following aggregate data:
● Usage summary data for cases
● Hosted file size data for cases
● User reports
You can create custom invoices for your clients using data from the portal management reports, if you import the data into an application like Microsoft Excel. For example, you can create an invoice that includes the hosted data volumes by case, which you retrieve in a query to the Ringtail Connect API, multiplied by the hosting fee. As another example, you can create an invoice that includes the number of production pages for a range of dates, which you retrieve in a query, multiplied by the production printing fee.
For more information about the Portal Management Reports section of Ringtail, see Portal Management Reports.
To generate a report of portal management data, run the following query. You can add or remove fields in the query as required, depending on the data that you want to retrieve. You can also include arguments. For example, you can limit the data to a specific date range, or filter the results based on case or organization. Refer to the reference documentation for a full list of the available fields and arguments. For information about how to access the reference documentation, see Reference documentation.
query { cases { name statistics { metricsAvailability aggregateBaseDocsUsageSummary aggregateDatabases aggregateTotalHostedSize countOfDocsWithNoContent countOfDocsWithNoPages countOfDocsWithNoPagesAndNoContent countOfDocsWithPagesAndContent countOfImportDocs countOfImportJobs countOfIngestionDocs countOfIngestionJobs countOfOcrPages countOfPredictedDocs countOfProductionDocs countOfProductionJobs countOfProductionPages countOfTiffedPages countOfTranslatedDocs dtIndexSize sizeOfBaseDocumentsHostedDetails sizeOfFolderData_BatchPrint sizeOfFolderData_cases sizeOfFolderData_dtOptions sizeOfFolderData_dtThesaurus sizeOfFolderData_Export sizeOfFolderData_ImageRepositoryOther sizeOfFolderData_Import sizeOfFolderData_ingest sizeOfFolderData_Ingest_Temp sizeOfFolderData_Predict sizeOfFolderData_Suppressed sizeOfFolderData_Upload sizeOfImportDocs sizeOfIngestionDocs sizeOfMissingFiles sizeOfNonDocumentData sizeOfOrphanFiles sizeOfRenditionsHostedDetails sizeOfAllOtherFolderData } } }