Legacy report

Synopsis

Get a cacheable report. This function uses Reporting v1 API.

Syntax

Get-LegacyReport -Name <String> -Version <String> -Start <String> -End <String> [-ObjectIDs <String[]>] -Interval <String> [-Filters <String>] [-Metrics <String[]>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-LegacyReport -Name <String> -Version <String> -Start <String> -End <String> [-AllObjectIDs] -Interval <String> [-Filters <String>] [-Metrics <String[]>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Retrieve data for a specific version of a type of report. While functionally identical to New-LegacyReport, this alternative GET operation specifies all request data as query parameters.

Parameters

`‑AccountSwitchKey`	StringPipeline input: False An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
`‑AllObjectIDs`	SwitchParameter sets: `Get all IDs`Pipeline input: False An alternative to `-ObjectIDs`, enabling this generates a report that includes all IDs available for the specified object type (each report supports only one specific object type). This parameter is ignored if the request also specifies a set of `-ObjectIDs`.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑End` Required	StringPipeline input: False The end of the reported period as an ISO 8601 timestamp with a timezone. Any data that matches the `end` value's timestamp is excluded from the report.
`‑Filters`	StringPipeline input: False The criteria to filter the report's data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (`=`) character, and separate various name-value pairs with commas (`,`). To specify more than one filter value, repeat the filter name.
`‑Interval` Required	StringAccepted values: `FIVE_MINUTES`, `HOUR`, `DAY`, `WEEK`, `MONTH`Pipeline input: False The duration of each data record, either `FIVE_MINUTES`, `HOUR`, `DAY`, `WEEK`, or `MONTH`. Support for specific interval values may vary by report type.
`‑Metrics`	String[]Pipeline input: False A comma-separated list of metrics to include in the report, otherwise all metrics are retrieved if omitted. The set of available metrics depends on the type of report.
`‑Name` Required	StringPipeline input: ByPropertyName The type of report.
`‑ObjectIDs`	String[]Parameter sets: `Get by IDs`Pipeline input: False An alternative to `-AllObjectIDs`, specifies the set of unique IDs for the given object type you want to report on, formatted as a comma-delimited list.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑Start` Required	StringPipeline input: False The start of the reported period as an ISO 8601 timestamp with timezone.
`‑Version` Required	StringPipeline input: ByPropertyName The version of the report type.

Related Links

User Guide: Reporting

Updated 12 days ago