Get-RelativityMonthlyMetric

Heads up!

Relativity monthly metrics represent the last collected metrics for a given month and, unlike Relativity metrics, are never archived or automatically removed by the system. If you are looking for more recent granular data represented daily, check out the Get-RelativityMetric cmdlet.

Summary

Retrieves an existing Relativity monthly metric.

Get-RelativityMonthlyMetric
    -Id

Returns a Relativity monthly metric object.

Parameters

Examples

Get an existing Relativity monthly metric

This example retrieves a specific Relativity monthly metric and outputs it as JSON.

# Retrieve a specific Relativity monthly metric by id
$metric = Get-RelativityMonthlyMetric -Id 23

Write-Output "Retrieved Relativity monthly metric '$($metric.FieldName)' (Id: #$($metric.RelativityMonthlyMetricId), Report Period: $($metric.ReportPeriodYear)-$($metric.ReportPeriodMonth), Value: $($metric.ValueAsDouble))"

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

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

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved Relativity monthly metric 'Peak Workspace Hosted Size [GB]' (Id: #23, Report Period: 2025-3, Value: 0.91)

JSON Results:
{
  "RelativityMonthlyMetricId": 23,
  "ReportPeriodYear": 2025,
  "ReportPeriodMonth": 3,
  "LastMetricTimestamp": "2025-04-01T04:59:00+00:00",
  "LastRelativityUsageReportRequestId": 34,
  "LastUsageReportRequest": null,
  "LastUsageReportRequestKeyId": "d3ba6660-0557-4488-a236-fcefed41ccb6",
  "LastUsageReportRequestName": "Generated by Agility Blue on 2025-04-01 12:00:04Z",
  "RelativityMetricFieldId": 23,
  "Field": null,
  "FieldMetricKeyId": "44873755-99cb-49a8-98ce-157a5ce6a38a",
  "FieldName": "Peak Workspace Hosted Size [GB]",
  "FieldDescription": "The largest summed size of all natives, images and produced images in the workspace within the given month, in GB.",
  "FieldEnabled": true,
  "FieldOrigin": "Workspace Utilization",
  "FieldValueType": "Double",
  "FieldLayoutStyle": "Stat Box",
  "FieldLayoutPosition": 2,
  "WorkspaceArtifactId": 1021745,
  "ValueAsText": null,
  "ValueAsInt64": null,
  "ValueAsDouble": 0.91,
  "ValueAsDateTime": null,
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedBy": null,
  "CreatedByFullName": "Max Miller",
  "CreatedOn": "2025-03-02T14:23:16.3692784+00:00",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedBy": null,
  "LastUpdatedByFullName": "Max Miler",
  "LastUpdatedOn": "2025-04-01T12:00:22.2984596+00:00"
}