Billing Insights API field mapping

The Billing Insights API returns the data shown in Management Console. This topic maps each report field to its API path. Use it to match an API value to a field in the UI.

Field descriptions are not repeated here. Each report field links to its description in Cost Explorer or Usage Reports.

Scope and endpoints

This topic covers the read-only endpoints that return Management Console report data. For authentication, request syntax, and response schemas, see Billing Insights API (REST) on the Relativity Developers site. Both a V1 and a V2 reference are available there.

• month-details—returns workspace attributes, billable metrics, and current usage metrics for a given month.
• users-details—returns per-user billing and activity data for a given month.
• hierarchy-lookup—returns the artifact IDs used to filter the other calls.

You can find the instance ID used to authenticate to the API at the top of the Cost Explorer report. For more information, see Cost Explorer.

Workspace and identifier fields

These fields come from the month-details endpoint. They identify the client, matter, instance, and workspace that a billing record belongs to.

Report field	API path	Notes
Client Name	client.name	Returns a hash when the value is anonymized.
Client Number	client.number	Returns a hash when the value is anonymized.
Client Artifact ID	client.artifactID
Client Status	client.status	May return empty.
Matter Name	matter.name	Returns a hash when the value is anonymized.
Matter Number	matter.number	Returns a hash when the value is anonymized.
Matter Artifact ID	matter.artifactID
Contract Name	contract.name	The subscription name shown at the top of Cost Explorer.
Contract ID	contract.id
Instance Name	instance.name
Instance ID	instance.id	Use this GUID to authenticate to the API.
Instance Pricing Visibility	instance.pricingVisibility	Indicates whether pricing is visible for the instance. Returns Visible, HiddenResoldInstance, or HiddenFixedContract.
Workspace Name	workspace.name	Returns a hash when the value is anonymized.
Case Artifact ID	workspace.artifactID
Workspace ID	workspace.id
Project Type	workspace.projectType	Returns Not Set when no Project Type is assigned.
Activity Status	workspace.activityStatus
Workspace Status	workspace.workspaceStatus	The official status of the workspace, such as Active, Inactive, Archived, or Deleted. This value differs from the Usage Reports Workspace State field.
Billable Workspace Type	workspace.billableType	Returns Review, Repository, or Cold Storage.
Workspace Billable Status	workspace.billableStatus	Returns Billable, Non-billable, or Billable Plaintiff.
Repository Usage Limitations Status	workspace.billableComment	Returns Not exceeded, or Exceeded with the limitation that was surpassed.
Client anonymized fields	client.anonymization, client.anonymizedFields	For more information, see Hashed and anonymized values.
Matter anonymized fields	matter.anonymization, matter.anonymizedFields	For more information, see Hashed and anonymized values.
Workspace anonymized fields	workspace.anonymization, workspace.anonymizedFields	When the workspace is hashed, the Name value is replaced with the artifact ID. For more information, see Hashed and anonymized values.

Billable cost and size fields

These fields come from the pricedMetrics object on the month-details endpoint. Cost values return under amount.value, and amount.currency returns USD. Size and count values return under billableValue.

Report field	API path	Notes
Billable Review Cost [USD]	pricedMetrics.Relativity_Storage_Review.amount.value
Billable Review File Size [GB]	pricedMetrics.Relativity_Storage_Review.billableValue
Billable Repository Cost [USD]	pricedMetrics.Relativity_Storage_Repository.amount.value
Billable Repository File Size [GB]	pricedMetrics.Relativity_Storage_Repository.billableValue
Billable Cold Storage Cost [USD]	pricedMetrics.Relativity_Storage_ColdStorage.amount.value
Billable Cold Storage File Size [GB]	pricedMetrics.Relativity_Storage_ColdStorage.billableValue
Billable Linked File Size [GB]	pricedMetricsSubMetricsSummary.Relativity_Storage_Linked.value
Billable Text Only Records Count	pricedMetricsSubMetricsSummary.Relativity_Storage_TextOnlyDocuments.value	The API metric key uses Documents. The report label uses Records.
Billable aiR for Review Cost [USD]	pricedMetrics.aiR_for_Review.amount.value
Billable aiR for Privilege Cost [USD]	pricedMetrics.aiR_for_Privilege.amount.value
Billable aiR for Case Strategy Cost [USD]	pricedMetrics.aiR_for_CaseStrategy.Document.amount.value
Billable aiR for Case Strategy Documents	pricedMetrics.aiR_for_CaseStrategy.Document.billableValue	Counts documents over the contract threshold.
Billable aiR for Case Strategy Initial Fee [USD]	pricedMetrics.aiR_for_CaseStrategy.AppInstallation.amount.value or pricedMetrics.aiR_for_CaseStrategy.WorkspaceOneTimeFee.amount.value	The path depends on the product availability stage. AppInstallation applies to LGA, and WorkspaceOneTimeFee applies to GA.
Billable Translation Cost [USD]	pricedMetrics.Relativity_Translate.amount.value
Billable Data Breach Cost [USD]	pricedMetrics.Relativity_DB_Response.amount.value
Billable Data Breach File Size [GB]	pricedMetrics.Relativity_DB_Response.billableValue	Returns the peak size of the data uploaded for Data Breach Response in the month, in GB.
Billable Contracts Cost	pricedMetrics.Relativity_Contracts_Document.amount.value
Billable PI Detect Cost	pricedMetrics.Relativity_PI_Detect.amount.value	We deprecated this field in February 2025.
RelativityOne Users Cost	pricedMetrics.Relativity_Users_RelOne.amount.value and .billableValue	The billableValue path returns the user count.
Server Users Cost	pricedMetrics.Relativity_Users_Server.amount.value and .billableValue	The billableValue path returns the user count.
Non-Billable Users	pricedMetrics.Relativity_Users_NonBillable.amount.value and .billableValue	The cost value is typically zero.

Current usage fields

These fields come from the usageMetrics object on the month-details endpoint. They report usage as of the Report Date rather than the Peak Day. Each metric also returns a collectionTimeUtc value.

Report field	API path	Notes
Current Review File Size [GB]	usageMetrics.Relativity_Storage_Review.reportedValue
Current Repository File Size [GB]	usageMetrics.Relativity_Storage_Repository.reportedValue
Current Cold Storage File Size [GB]	usageMetrics.Relativity_Storage_ColdStorage.reportedValue
Current Linked File Size [GB]	usageMetricsSubMetricsSummary.Relativity_Storage_Linked.value
Current Text Only Records Count	usageMetricsSubMetricsSummary.Relativity_Storage_TextOnlyDocuments.value	The API metric key uses Documents. The report label uses Records.
aiR for Review Documents	usageMetrics.aiR_for_Review.reportedValue
aiR for Privilege Documents	usageMetrics.aiR_for_Privilege.reportedValue
aiR for Case Strategy Documents	usageMetrics.aiR_for_CaseStrategy.Document.reportedValue
Translate Doc Units	usageMetrics.Relativity_Translate.reportedValue
Current Data Breach File Size	usageMetrics.Relativity_DB_Response.reportedValue
Contracts Doc Units	usageMetrics.Relativity_Contracts_Document.reportedValue
PI Detect Doc Units	usageMetrics.Relativity_PI_Detect.reportedValue	We deprecated this field in February 2025.
Current user counts	usageMetrics.Relativity_Users_RelOne.reportedValue, ...Relativity_Users_Server.reportedValue, ...Relativity_Users_NonBillable.reportedValue	Returns the current count for each user category.

User fields

These fields come from the users-details endpoint. They correspond to the Users table in Cost Explorer. Keys in instanceSpecificData are lowercase instance GUIDs.

Report field	API path	Notes
Email Address	email	The username is replaced by a hash when anonymized. The domain remains unhashed.
User Artifact ID	instanceSpecificData.<instanceId>.artifactID	Returned per instance.
User Access Level	userRole	Returns Regular or System Administrator.
Type	userType	Returns Internal or External.
User Activity	userActivity	Returns Active or Inactive for the month.
Last Login	lastLoginUtc	Reports up to 12 months. Returns empty when there is no login in that period.
Billable Status	billableStatus	Returns Billable RelativityOne, Billable Server, or Non-billable.
Additional Information	comment	For example, Relativity Connect or Justice for Change.
Instance (per user)	instanceSpecificData.<instanceId>.instance	Returns the instance ID and name for that user.
Workspaces	workspaces	Returns the workspace artifact IDs the user can access. This value does not appear in the Users table.
Anonymized fields	anonymization, anonymizedFields	For more information, see Hashed and anonymized values.

Hierarchy lookup fields

The hierarchy-lookup endpoint returns the artifact IDs used to filter the other calls. The selector object identifies each item, and the properties it returns depend on the requested level.

Report field	API path	Notes
Name	name	Returns the client, matter, or workspace name for the requested level.
Instance ID	selector.instanceID	Returned at every level.
Contract ID	selector.contractID	Optional. May return empty.
Client Artifact ID	selector.clientArtifactID	Returned when the level is Client.
Matter Artifact ID	selector.matterArtifactID	Returned when the level is Matter.
Workspace Artifact ID	selector.workspaceArtifactID	Returned when the level is Workspace.
Anonymized fields	anonymization, anonymizedFields	For more information, see Hashed and anonymized values.

Hashed and anonymized values

When your instance settings enable hashing, the API returns hashed values for the following fields:

• Client Name and Client Number.
• Matter Name and Matter Number.
• Workspace Name.
• Email Address, where the username is hashed and the domain remains unhashed.

Each object returns an anonymization value and an anonymizedFields map. The map shows which properties are hashed. For example, anonymizedFields may return name as Hashed and number as None.

To resolve a hashed value, match the object artifact ID through the Object Manager API.