RErelativity
BillingInsights

Get monthly billing metrics

Get monthly billing metrics at the specific level (Workspace, Matter, Client, Instance) for a given date. If the requested data does not exist then an empty list will be returned (e.g. instance didn't exist in a given month)

post/api/v2/billing-insights/month-details

Request

Request body

dateKeystring nullable

Specifies the year and the month for which details should be returned. Format: YYYYMM.

metricKeysstring[] nullable

An array of metric keys for which the data should be returned. If no metric keys are provided, no metrics will be returned. List of possible values:

  • Relativity_Storage_Review
  • Relativity_Storage_Repository
  • Relativity_Storage_ColdStorage
  • Relativity_Users_RelOne
  • Relativity_Users_Server
  • Relativity_Users_NonBillable
  • Relativity_Storage_Staging
  • Relativity_Translate
  • Relativity_PI_Detect
  • Relativity_DB_Response
  • Relativity_Contracts_Document
  • aiR_for_Review
  • aiR_for_Privilege
  • aiR_for_CaseStrategy.AppInstallation
  • aiR_for_CaseStrategy.WorkspaceOneTimeFee
  • aiR_for_CaseStrategy.Document
  • FOIA_Request
  • FOIA_DisclosureCenter_Storage
  • FOIA_ReadingRoom_Storage
  • MigrationAccelerator_Credit (workspace level only; present for every workspace of a contract in the Migration Accelerator program; workspaces without credit carry comment 'Not migrated')
subMetricsSummaryKeysstring[] nullable

An array of submetric keys for subMetricsSummary fields for which the data should be returned. If no submetric keys are provided, no submetrics will be returned under subMetricsSummary fields. Keep in mind that all submetrics under main metric keys (Review, Repo etc.) will be returned despite this parameter. List of possible values:

  • Relativity_Storage_TextOnlyDocuments
  • Relativity_Storage_Linked
selectorLevel'Workspace' | 'Matter' | 'Client' | 'Instance' | 'Contract'

Specifies the hierarchy level for which itemSelectors should apply. The itemSelectors contract level is not supported.

level'Workspace' | 'Matter' | 'Client' | 'Instance' | 'Contract'

Specifies the hierarchy level for which the data should be returned

shouldUnhashDataboolean

Specifies if the response should include unhashed data. Default value is false.

includeMaxPrecisionboolean

Specifies if reportedValueMaxPrecision should be included on usage metrics that have it. Default value is false. A caller that does not set this stays on the rounded reportedValue it already gets today, even after the upstream full-precision data becomes available - the extra field is opt-in, not automatic.

Example request

{
  "dateKey": "202209"
}

Response

OK

status'OK' | 'ContractExpired' | 'ContractNotAvailable' | 'ContractInPreparation' | 'MissingDataForContract' | 'FunctionalityDisabled' | 'MissingMetricsGuid'

Changes

No recorded changes to this operation across all 1 revision of this API.