Get-RelativityUsageReportRequest

Summary

Retrieves an existing Relativity usage report request.

Get-RelativityUsageReportRequest
    -Id

Returns a Relativity usage report request object.

Parameters

Examples

Get an existing Relativity usage report request

This example retrieves a specific Relativity usage report request and outputs it as JSON.

# Retrieve a specific Relativity usage report request by id
$entity = Get-RelativityUsageReportRequest -Id 326

Write-Output "Retrieved Relativity usage report request '$($entity.Name)' (Id: #$($entity.RelativityUsageReportRequestId), Status: $($entity.Status))"

# For debug purposes, convert the Relativity usage report request to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $entity | ConvertTo-Json -Depth 10

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved Relativity usage report request 'Generated by Agility Blue on 2026-01-19 10:00:01Z' (Id: #326, Status: Completed)

JSON Results:
{
  "RelativityUsageReportRequestId": 326,
  "UsageReportKeyId": "5a3c1d61-8385-493a-8199-8574d0d6a982",
  "IntegrationId": 1,
  "Integration": null,
  "IntegrationName": "Relativity",
  "IntegrationIdentifier": "https://agilityblue.relativity.one",
  "IntegrationEnabled": true,
  "TenantId": "c158517c-5c42-4e26-a2aa-6a4470eef6c1",
  "Name": "Generated by Agility Blue on 2026-01-19 10:00:01Z",
  "FromDate": "2026-01-01T00:00:00+00:00",
  "ToDate": "2026-01-31T00:00:00+00:00",
  "Type": "Workspace",
  "Status": "Completed",
  "CreatedAt": "2026-01-19T10:00:01.9486405+00:00",
  "Version": 1,
  "CollectedOn": "2026-01-19T10:00:15.1119703+00:00",
  "CountOfCollectedMetrics": 180,
  "CountOfCollectedWorkspaces": 9,
  "CountOfErrorsDuringCollection": 0,
  "ArchivedOn": null,
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedBy": null,
  "CreatedByFullName": "Max Miller",
  "CreatedOn": "2026-01-19T10:00:01.9821869+00:00",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedOn": "2026-01-19T10:00:15.15137+00:00",
  "Metrics": []
}