Last date modified: 2026-Nov-13
Getting Started with Usage Reports API
Welcome to the Usage Reports API. This guide will help you get started with the API, including making your first requests, understanding the available endpoints, and authenticating your API calls.
Permissions
To use the Usage Reports API, users must have one of the following instance-level permissions:
-
View Client Domain Usage Reports
- Allows users to create Usage Reports across the workspaces they have access to.
- This permission is suitable for users who need to generate reports for specific client domains.
-
View Instance-wide Usage Reports
- Allows users to create Usage Reports across the entire instance (all workspaces), even without direct access to those workspaces.
- This permission is ideal for roles like customer finance team members or API account users who need to generate reports for client billing.
- System Administrators must also be assigned the View Instance-wide Usage Reports permission in order to generate reports across all workspaces.
-
View Cost Explorer(required for billing metrics)
- Controls access to billing and cost-related metrics (e.g., storage billing, product billing charges) in both the metadata endpoint and report data.
- Without this permission, billing metrics are excluded from the
GET /metadataresponse and reports that contain billing metrics return404 Not Foundwhen read or downloaded. - Billing metrics are stripped at report creation time if the creator lacks View Cost Explorer; any report that contains billing metrics requires View Cost Explorer when read/downloaded (otherwise
404 Not Found). - This permission is independent of the instance-wide / client-domain split above; users need both the appropriate usage reports permission and View Cost Explorer to access billing data.
See the user guide help topic Setting instance permissions for information on confuguring permissions.
URLs
The URLs for the REST API endpoints include a path parameter {version} that you need to set before making a call:
<host>/api/usage-reports/{version}
Replace {version} with the API version you want to use. Use the format lowercase v followed by the version number, for example v2.
Example URL:
<host>/api/usage-reports/v2/metadata
API Versions
| Version | Status |
|---|---|
v2
|
Current. Metric names and descriptions use the Relativity aiR product names - see Metric Name Changes in v2. |
v1
|
Deprecated, but still available. Removal is planned no earlier than 3 months after the deprecation announcement on 11/23/2026. Returns the metric names used before the rename. |
To migrate, replace /v1/ with /v2/ in request URLs and update any code that reads metric names (the CSV header row or name in metadata) to the v2 names. The reports endpoints take the same requests and return the same JSON responses in both versions; only the metric names in the downloaded CSV header row differ. GET /v2/metadata returns a flat metric list instead of v1's origins.
Metric IDs, report IDs and existing reports do not change. A report created through v1 can be read and downloaded through v2.
Relativity aiR REST API Authentication
To access the Usage Reports API, you must authenticate your requests. Relativity aiR supports Bearer Token Authentication.
Basic authentication is no longer supported.
Bearer Token Authentication
You can connect to the REST services using bearer token authentication. When using bearer token authentication, clients access the service with an access token issued by the Relativity identity service based on a consumer key and secret obtained through an OAuth2 client.
When multiple web servers are hosted behind a load balanced route, you can't programmatically retrieve an authentication token. You must use a direct route to one of the web servers to retrieve the authentication token.
To create, obtain and use a bearer access token:
- Create a Relativity OAuth2 Client (for more information see OAuth2 clients on the Relativity aiR Documentation site):
- Click Home > Authentication > OAuth2 Client Manager.
- Click New OAuth2 Client to create a new client, or click Edit to modify an existing client.
- Complete the fields on the form. Fields in orange are required:
- Name- enter a unique name for the OAuth2 client.
- Enabled- indicate whether the client will have access to Relativity.
- Flow Grant Type- select Client Credentials.
- Context User- select a user with the appropriate level of permissions or group membership for the operations you want to perform. (Usually a member of the Relativity Administrators group, but could be different depending on the API or operation invoked).
- Access Token Lifetime- set the duration (in minutes) for which access tokens are valid. The recommended value is 60 minutes.
- Click Save to create the OAuth2 client. For more information, see OAuth2 clients on the Relativity aiR Documentation site.
- Obtain a Bearer Token by sending a POST request to the token endpoint with your credentials.Copy
curl -X POST "<host>/Relativity/Identity/connect/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "scope=SystemUserInfo" \
-d "client_id=<your_client_id>" \
-d "client_secret=<your_client_secret>" \ - Use the Bearer Token by including the token in the Authorization header of your API requests.
curl -X GET "<host>/api/<servicename>/<versionnumber>/<endpoint>" \
-H "Authorization: Bearer <your_access_token>"
The sample below shows how to use the token in a request to the Metadata endpoint of the usage-reports service:
curl -X GET "{host}/api/usage-reports/v2/Metadata" \
-H "Authorization: Bearer {your_access_token}"
Rate Limiting
To ensure fair usage and maintain the stability of our services, we implement rate limiting on our API endpoints. This means that there is a restriction on the number of requests you can make within a given timeframe.
Currently, you're allowed to send 65 requests per 60-second interval.
When you exceed the allowed request limit, your requests will be temporarily blocked, and you'll receive an HTTP 429 Too Many Requests status code.
API Endpoints
Rate Limiting To ensure fair usage and maintain the stability of our services, we implement rate limiting on our API endpoints. This means there's a restriction on the number of requests you can make within a given timeframe.
Get Metadata
To retrieve metadata fields for report creation, send a GET request with the following URL format:
<host>/api/usage-reports/v1/metadata
{
"origins": [
{
"metrics": [
{
"id": "18af070c-5f4a-407b-a4c8-93b1c4fffc34",
"name": "Workspace Artifact ID",
"description": "The unique identifier for the workspace within the instance.",
"valueType": "Int64",
"originId": "35dff1e2-c391-4fa4-9897-0999358f8c13",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "bd708c94-c51b-44e5-bc2d-29378fe72bf7",
"name": "Report Period",
"description": "The month and year that the workspace utilization metrics covers. This will be formatted in month/year.",
"valueType": "DateTime",
"originId": "35dff1e2-c391-4fa4-9897-0999358f8c13",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "2b97c766-052f-424a-85eb-fdaffc25ffdf",
"name": "Matter ArtifactID",
"description": "The unique identifier for the matter within the instance.",
"valueType": "Int64",
"originId": "35dff1e2-c391-4fa4-9897-0999358f8c13",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
}
],
"id": "35dff1e2-c391-4fa4-9897-0999358f8c13",
"name": "Workspace Utilization"
},
{
"metrics": [
{
"id": "6f9619ff-8b86-d011-b42d-00c04fc964ff",
"name": "Workspace Artifact ID",
"description": "The unique identifier for the Workspace within the instance.",
"valueType": "Int64",
"originId": "229954a5-052d-4c67-b144-5e07847a52f4",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "59f7c2a8-feb3-4ee0-8f4a-d7359ee58d17",
"name": "Processing Data Source Count",
"description": "The number of data sources for the processing set where the status is either “Completed” or “Completed with Errors”.",
"valueType": "Int64",
"originId": "229954a5-052d-4c67-b144-5e07847a52f4",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
}
],
"id": "229954a5-052d-4c67-b144-5e07847a52f4",
"name": "Processing Statistics"
},
{
"metrics": [
{
"id": "f0931643-5aee-414a-9c53-495b71bae5fc",
"name": "Contracts Document Units",
"description": "The total number of document units processed using Relativity Contracts.",
"valueType": "Int64",
"originId": "eb6ba799-31fc-4f92-abff-690dd341cd08",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "241df315-c954-405f-8d09-0ac5cfdb7de3",
"name": "Current Data Breach File Size",
"description": "The current size of data included in Data Breach Response.",
"valueType": "Double",
"originId": "eb6ba799-31fc-4f92-abff-690dd341cd08",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
}
],
"id": "eb6ba799-31fc-4f92-abff-690dd341cd08",
"name": "Processing Utilization"
},
{
"metrics": [
{
"id": "a6bda9d5-23d7-4b6c-86f8-513d55e8f66e",
"name": "User Email Address",
"description": "The email address associated to the user.",
"valueType": "Text",
"originId": "3f7d2ad3-e7d3-4866-bda2-4c7494dcc690",
"reportType": "User",
"isDefault": true,
"isActive": true
},
{
"id": "39a5b2b5-6aef-4d67-9bc4-f63c730883f9",
"name": "Enabled User Information Capture Date-Time",
"description": "The date/time that the enabled user information were captured from the instance. The value is shown in UTC.",
"valueType": "DateTime",
"originId": "3f7d2ad3-e7d3-4866-bda2-4c7494dcc690",
"reportType": "User",
"isDefault": true,
"isActive": true
}
],
"id": "3f7d2ad3-e7d3-4866-bda2-4c7494dcc690",
"name": "User Information"
}
]
}
Get Metadata (v2)
v2 drops the origins grouping used by v1. Send a GET request with the following URL format:
<host>/api/usage-reports/v2/metadata
The response is a flat list of metrics — each metric no longer carries an originId.
{
"metrics": [
{
"id": "18af070c-5f4a-407b-a4c8-93b1c4fffc34",
"name": "Workspace ArtifactID",
"description": "The unique identifier for the workspace within the instance.",
"valueType": "Int64",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "9bd5d6b0-9d21-4c4d-98cd-3698248e7cfc",
"name": "Current File Count",
"description": "The number of all files (including but not limited to natives, images and produced images) in storage for the workspace at the workspace utilization capture date-time.",
"valueType": "Int64",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
},
{
"id": "f0931643-5aee-414a-9c53-495b71bae5fc",
"name": "Contracts Document Units",
"description": "The total number of document units processed using Contracts.",
"valueType": "Int64",
"reportType": "Workspace",
"isDefault": false,
"isActive": true
}
]
}
List Reports
To list all reports, send a GET request with the following URL format:
<host>/api/usage-reports/v2/reports
{
"reports": [
{
"id": "1240a7dd-5338-4046-9e00-41f9a8be9add",
"tenantId": "1234565b-955b-4693-9078-505f1018bfcf",
"name": "Report 01/01/2026",
"dateRange": {
"from": "2026-01-01T00:00:00Z",
"to": "2026-01-31T00:00:00Z"
},
"fields": [
"233c0387-a246-4b9f-80b4-772ab8d41062",
"4b7a9d1f-8c3e-4e0c-8d2b-9a6a5c0f3e1a",
"3749241a-d2f7-45d3-a798-0ab7d20c8b71",
"89b2fc03-8cd9-494c-8204-4a62fd05975b",
"05b152e6-c56c-40fd-a4ef-853efa4ba624",
"f68f2d4c-ba9a-4831-a903-113ad5ce4b91",
"ece1332d-39ba-4460-a50e-345deba7af05",
"61bc4e25-ce8e-415c-bb55-6863f3844af0"
],
"status": "Completed",
"createdAt": "2026-02-01T12:00:00.8222732+00:00",
"type": "Workspace",
"dataMaxPrecision": false,
"version": 1
},
{
"id": "61203fa6-e526-4d65-9e01-ef7002b215e9",
"tenantId": "533d225b-955b-4693-9078-505f1018bfcf",
"name": "Report 02/01/2026",
"dateRange": {
"from": "2026-02-01T00:00:00Z",
"to": "2026-02-28T00:00:00Z"
},
"fields": [
"4c1fa36e-0fda-4f6a-abb9-2d542be04fd2",
"e42e478d-5dcc-49bd-b91b-3de824a92c3a",
"6bd6b190-85ff-49a9-832d-e66a07959b3d",
"bc1caedc-e3f9-4d29-a4cb-04e7942f598f",
"a871c32c-854b-4b49-ac00-5aa005f58c9a",
"27e8b363-7f6a-4d85-be85-32533b3f3f5a",
"965e287d-cc4a-4501-b43a-b7fb3f1cfd0a",
"a6bda9d5-23d7-4b6c-86f8-513d55e8f66e",
"39a5b2b5-6aef-4d67-9bc4-f63c730883f9"
],
"status": "Scheduled",
"createdAt": "2026-03-01T09:26:54.7540367+00:00",
"type": "User",
"version": 1
}
]
}
Generate New Report
To generate a new report, send a POST request with the following URL format and request body:
<host>/api/usage-reports/v2/reports
By default, report columns follow the order of fields in the request, for both report types, with any
default fields merged in appended after them. The service does not reorder them.
Set "applyDisplayOrder": true to hand that decision to the service instead. It then lays the columns out the way
the RelativityOne metric picker does (grouped by picker section, in a fixed order within each section) so the
same set of metrics always produces the same layout, and merged-in defaults are placed among the rest rather than
appended. v1 and v2 place every metric in the same position; only the names differ. This is what the report
creation wizard sends, because it collects metrics in the order the boxes were ticked. A metric the picker does not
show is kept and placed last.
Either way the stored order is what every later stage reads, so it is also the order of the header row of
Download Report by ID and of the fields array of Get Report and
Get Report Details. Reports generated before this flag existed keep the column order they
were created with.
{
"name": "Report 03/05/2026",
"dateRange": {
"from": "2026-03-05",
"to": "2026-03-05"
},
"fields": [
"4f8b9cf2-8e45-4b27-babc-3753e8a77f8c",
"ece1332d-39ba-4460-a50e-345deba7af05",
"29b400b3-4f47-4f8c-badf-94e2a5969763",
"2b97c766-052f-424a-85eb-fdaffc25ffdf",
"fcfdb1b9-0207-4851-a8f9-b653e4bbc851",
"40d897b5-113a-42e8-a354-2580b726d757",
"95d37233-b2d9-4e19-8f31-2304389ddbc0"
],
"dataMaxPrecision": false,
"explicitFieldsOnly": false,
"applyDisplayOrder": false
}
Notes
- When sending a request to create a report, ensure that all selected metrics belong to the same
reportType. ThereportTypecan either beWorkspaceorUser. Mixing metrics with differentreportTypevalues (e.g.,WorkspaceandUser) in the same request is not allowed and will result in an error. - The
dataMaxPrecisionflag controls the precision of GB values in theWorkspacetype report. By default (false), values are rounded to 2 decimal places. Set totrueto return values with maximum precision up to 15 decimal places. ForUserreports,dataMaxPrecisionmust be omitted or set tonull. - The
applyDisplayOrderflag controls the column order of the generated report. When omitted orfalse(the default), columns follow the order offieldsin the request. Whentrue, the service orders them as the metric picker does — see the note above. - The
explicitFieldsOnlyflag controls whether default metrics are automatically appended to the report. When omitted or set tofalse(the default), the service automatically adds default metrics for the selected report type to thefieldslist, and thefieldsarray must include at least one non-default metric. When set totrue, only the metrics explicitly listed infieldsare included — no defaults are added — and thefieldsarray must still include at least one non-default metric. - Each metric returned by the /metadata endpoint includes an
isActiveflag. When this flag is set tofalse, the metric is no longer supported in new reports and must be replaced with the corresponding active metric. - The following Workspace report metrics return values sourced directly from the Relativity Object Manager, providing full matter and client details: Matter Name (
89b2fc03-8cd9-494c-8204-4a62fd05975b), Matter Number (7df64877-5338-4af7-be96-ce277fc19172), Matter ArtifactID (2b97c766-052f-424a-85eb-fdaffc25ffdf), Client Name (3749241a-d2f7-45d3-a798-0ab7d20c8b71), Client Number (e7650f41-0771-4cd4-84ae-9589d4633f9e), and Client ArtifactID (29b400b3-4f47-4f8c-badf-94e2a5969763). If a workspace is deleted, no value is shown for matter- and client-related fields.
{
"id": "1240a7dd-5338-4046-9e00-41f9a8be9add",
"tenantId": "1234565b-955b-4693-9078-505f1018bfcf",
"name": "Report 03/05/2026",
"dateRange": {
"from": "2026-03-05T00:00:00Z",
"to": "2026-03-05T00:00:00Z"
},
"fields": [
"233c0387-a246-4b9f-80b4-772ab8d41062",
"4b7a9d1f-8c3e-4e0c-8d2b-9a6a5c0f3e1a",
"3749241a-d2f7-45d3-a798-0ab7d20c8b71",
"89b2fc03-8cd9-494c-8204-4a62fd05975b",
"05b152e6-c56c-40fd-a4ef-853efa4ba624",
"f68f2d4c-ba9a-4831-a903-113ad5ce4b91",
"ece1332d-39ba-4460-a50e-345deba7af05",
"61bc4e25-ce8e-415c-bb55-6863f3844af0"
],
"status": "Completed",
"createdAt": "2026-03-05T12:00:00.8222732+00:00",
"type": "Workspace",
"dataMaxPrecision": false,
"version": 1
}
Download Report by ID
To download a specific report, send a GET request with the following URL format:
<host>/api/usage-reports/v2/reports/download/{id}
The first line of the CSV is a header row of metric names, in the same order as the report's fields. The names
follow the API version of the download request, not the one the report was created with: /v2/ returns the v2
names, /v1/ the v1 names - see Metric Name Changes in v2.
Get Report
To get the details of a specific report, send a GET request with the following URL format:
<host>/api/usage-reports/v2/reports/{id}
{
"id": "1240a7dd-5338-4046-9e00-41f9a8be9add",
"tenantId": "1234565b-955b-4693-9078-505f1018bfcf",
"name": "Report 01/01/2026",
"dateRange": {
"from": "2026-01-01T00:00:00Z",
"to": "2026-01-31T00:00:00Z"
},
"fields": [
"233c0387-a246-4b9f-80b4-772ab8d41062",
"4b7a9d1f-8c3e-4e0c-8d2b-9a6a5c0f3e1a",
"3749241a-d2f7-45d3-a798-0ab7d20c8b71",
"89b2fc03-8cd9-494c-8204-4a62fd05975b",
"05b152e6-c56c-40fd-a4ef-853efa4ba624",
"f68f2d4c-ba9a-4831-a903-113ad5ce4b91",
"ece1332d-39ba-4460-a50e-345deba7af05",
"61bc4e25-ce8e-415c-bb55-6863f3844af0"
],
"status": "Completed",
"createdAt": "2026-02-01T12:00:00.8222732+00:00",
"type": "Workspace",
"dataMaxPrecision": false,
"version": 1
}
Get Report Details
To get detailed information of a report with pagination, send a GET request with the following URL format:
<host>/api/usage-reports/v2/reports/{id}/details?pageNumber={pageNumber}&pageSize={pageSize}
{
"fields": [
"233c0387-a246-4b9f-80b4-772ab8d41062",
"4b7a9d1f-8c3e-4e0c-8d2b-9a6a5c0f3e1a",
"3749241a-d2f7-45d3-a798-0ab7d20c8b71",
"89b2fc03-8cd9-494c-8204-4a62fd05975b",
"05b152e6-c56c-40fd-a4ef-853efa4ba624",
"f68f2d4c-ba9a-4831-a903-113ad5ce4b91",
"ece1332d-39ba-4460-a50e-345deba7af05",
"61bc4e25-ce8e-415c-bb55-6863f3844af0"
],
"items": [
[
"R1 - Report - 1",
"RelativityOne Review Template (v4.0.0)",
"Relativity Template",
"Relativity Template",
"2026-03-01T04:46:00",
null,
0,
0
],
[
"R1 - Report - 2",
"RelativityOne Investigations Template (v2.1.1)",
"Relativity Template",
"Relativity Template",
"2026-03-01T04:46:00",
null,
0,
0
],
[
"R1 - Report - 3",
"RelativityOne Automation",
"Relativity Template",
"Relativity Template",
"2026-03-01T04:46:00",
null,
0,
0
],
[
"R1 - Report - 4",
"RelativityOne Maintenance",
"Relativity Template",
"Relativity Template",
"2026-03-01T04:46:00",
null,
1.32,
0
],
[
"R1 - Report - 5",
"RelativityOne Template for ClientDomain",
"ClientDomain",
"ClientDomain Matter",
"2026-03-01T04:46:00",
null,
0,
0
]
],
"currentPage": 1,
"pageSize": 10,
"totalItems": 5
}
Delete Report
To delete a specific report, send a DELETE request with the following URL format:
<host>/api/usage-reports/v2/reports/{id}
PowerShell Code Samples for Usage Reports
Bearer Access tokens in PowerShell
You can use the following sample script to authenticate and retrieve an access token with PowerShell
# Set Variables (replace with appropriate values from your environment)
$relativityHost = "<host>"
$clientId = "XXX"
$clientSecret = "XXX"
# Define headers, Uri and body for authentication
$tokenHeaders = @{
'Content-Type' = 'application/x-www-form-urlencoded'
}
$tokenUri = "$relativityHost/Relativity/Identity/connect/token"
$tokenBody = "grant_type=client_credentials&client_id=$clientId&client_secret=$clientSecret&scope=SystemUserInfo"
# Request Access Token
$accessToken = Invoke-RestMethod -Uri $tokenUri -Headers $tokenHeaders -Body $tokenBody -Method POST
# Extract the token (only the access token, not the full response)
$token = $accessToken.access_token
You can then use the token in a request, see the example below (replacing the placeholders with the values of the service you are interacting with)
$requestHeadersToUse = @{
Authorization = "Bearer $token"
'Content-Type' = "application/json"
}
# set the endpoint and method type
$requestUri = "$relativityHost/api/<servicename>/<version>/<endpoint>"
$methodType = "GET"
# send the request and get the reponse
$response = Invoke-RestMethod -Uri $requestUri -Method $methodType -Headers $requestHeadersToUse
# do something with the response
$response | ConvertTo-Json
Set Headers and Uri for Usage Reports
These headers are used specifically for making requests to the Usage Reports API, which does not use Kepler.
$headersToUseWithUsageReports = @{
Authorization = "Bearer $token"
'Content-Type' = "application/json"
}
$requestUri = "$relativityHost/api/usage-reports/v2/Reports"
Retrieve Usage Reports
Send a GET request to fetch usage reports.
Send request to fetch usage reports
$response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headersToUseWithUsageReports
Convert and display the response as JSON
$response | ConvertTo-Json
Notes
- Replace
<host>with your own host when using the sample. - The access token is obtained via client credentials authentication.
- The Usage Reports API requires Bearer Token Authorization.
- The Usage Reports API does not use Kepler.
Linked Repository Metrics Migration
Some Linked Repository metrics were originally reported in bytes (indicated by [B] in their display name). These legacy metrics have been superseded by equivalent metrics that report values in gigabytes ([GB]). The legacy metrics remain accessible via the /metadata endpoint and in existing saved reports, but they are marked with isActive: false and must not be used in new report configurations.
To preserve functionality, update any saved report configuration or integration that references a legacy metric GUID by replacing it with the corresponding new GUID from the table below. You can verify the status of any metric on your own instance by querying /metadata — legacy GUIDs are returned with isActive: false, and the replacement GUIDs with isActive: true.
Metric ID Mapping
| Metric Name | Legacy metric ID (isActive: false) |
New metric ID (isActive: true) |
|---|---|---|
| Linked Source Workspace ArtifactID | 66c27d9c-3832-443d-9ef4-8dbe44a60364
|
5fd5bfb0-10a3-446b-b49d-d94451a6f60b
|
Linked Source Image File Size [B] → [GB] |
693002b7-efca-47a5-8a19-77f812c3e8ea
|
ade0b9a5-753e-4197-ae5d-1cf2e7113ce9
|
Linked Source Native File Size [B] → [GB] |
52682273-2204-49d4-b1ca-3c163e67da8a
|
9fd7c224-4a5c-442b-9fed-0aa4401d2be5
|
Linked Source Production File Size [B] → [GB] |
0cdb419c-6156-4013-8598-cb133684543c
|
14053077-b79c-4689-9e24-a502cc21220e
|
Linked Source Total File Size [B] → [GB] |
2e4cf924-4455-4ef2-ac89-d6ed38c953b0
|
869514b5-ad22-4cb8-b512-e92fd9c8af3e
|
How Linked Repository rows are built
Linked Repository statistics are nested JSON arrays rather than flat columns: each row describes one source linked workspace (keyed by CaseArtifactID). The same set of linked repositories is exposed through more than one JSON data location:
LinkedRepositories— the legacy bytes ([B]) variant.LinkedRepositoriesGB— the gigabytes ([GB]) variant.LinkedRepositoriesGBMaxPrecision— the GB file sizes at full precision, used when a report is generated with max precision enabled.
These locations are parallel views of the same repositories, not independent datasets. Because the Linked Source Workspace ArtifactID column shares one display name across the bytes and GB variants, a single report can legitimately reference the ArtifactID from one location and the file sizes from another. When generating the report, matter-insights:
- Aligns the linked ArtifactID metric to whichever variant the report's linked file-size columns use, so the columns resolve to a single location wherever possible (driven by the report's field composition, not by the GB toggle — legacy all-bytes reports are left untouched).
- Merges any residual multiple locations into one row per linked repository, correlating rows by
CaseArtifactIDwhen every location carries it (falling back to array position otherwise) — never emitting a separate set of rows per data location.
This is why a workspace with N linked repositories produces exactly N rows (and a workspace with none produces a single row with empty Linked Source columns), regardless of how many [B]/[GB] Linked Repository metrics are selected together. Emitting one row set per data location previously produced duplicate and half-empty rows (REL-1331347).
Metric Name Changes in v2
v2 uses the Relativity aiR product names. The metrics below are renamed in v2 metadata and in the header row of reports downloaded through v2; v1 keeps the v1 names. Metric IDs, values and column positions do not change. Descriptions returned by metadata change with the names.
| Metric ID | v1 name | v2 name |
|---|---|---|
5d139fce-89ed-4df2-b1d9-adcfcd3a71ca
|
aiR for Case Strategy Documents | Case Strategy Documents |
4081b968-60b1-4aae-96ea-4b22689beecb
|
aiR for Privilege Documents | Privilege Documents |
967b074d-7d92-4ffe-8179-da334eb2ff2b
|
aiR for Review Documents | aiR Review Documents |
241df315-c954-405f-8d09-0ac5cfdb7de3
|
Current Data Breach File Size | Current Data Breach Response File Size |
8b311876-97c1-4bbe-b69e-38430f477c63
|
Peak Data Breach File Size | Peak Data Breach Response File Size |
8da00cbc-46d4-4e43-859e-3bbeac1c643e
|
Billable aiR for Case Strategy Cost [USD] | Billable Case Strategy Cost [USD] |
073180de-3e67-4d86-8acc-62816afb04f3
|
Billable aiR for Case Strategy Documents | Billable Case Strategy Documents |
afeef503-4100-41a9-ad3a-5b012101e31e
|
Billable aiR for Case Strategy Initial Fee [USD] | Billable Case Strategy Initial Fee [USD] |
25e4938a-0b4b-43c0-bc7d-7f695e520fce
|
Billable aiR for Privilege Cost [USD] | Billable Privilege Cost [USD] |
a1c4bed7-974c-49a3-adbf-9eead7c54b38
|
Billable aiR for Review Cost [USD] | Billable aiR Review Cost [USD] |
e4024210-57b9-43ba-861e-0ab76c201d94
|
Billable Data Breach Cost [USD] | Billable Data Breach Response Cost [USD] |
2dc0b235-f335-4676-b125-70250db33537
|
Billable Data Breach File Size [GB] | Billable Data Breach Response File Size [GB] |
1e26e59e-6526-40ee-9e30-f06a3846a157
|
Billable Translation Cost [USD] | Billable Translate Cost [USD] |