Legacy report

Synopsis

Generate a report. This function uses Reporting v1 API.

Syntax

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

New-LegacyReport -Name <String> -Version <Int32> -Start <String> -End <String> [-DataWrapLabel <String>] [-DataWrapNumberOfItems <Int32>] -Interval <String> -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Produce a report in either JSON or CSV format for a specific version of a type of report. In CSV data, values with commas or space characters are quoted. Query parameters specify the range of data and the aggregation interval for each record.

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.
`‑Body` Conditionally required	ObjectParameter sets: `Body`Pipeline input: ByValue A request body, either as a `PSCustomObject` or a string. This parameter supports pipelining.
`‑DataWrapLabel`	StringPipeline input: False Label used as title for grouped record.
`‑DataWrapNumberOfItems`	IntPipeline input: False For reports that allow non-top values to cluster, this specifies the number of top values to report on separately.
`‑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`	String[]Parameter sets: `Attributes`Pipeline 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[]Parameter sets: `Attributes`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` Conditionally required	String[]Parameter sets: `Attributes`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	IntPipeline input: ByPropertyName The version of the report type.

Related Links

User Guide: Reporting

Updated 12 days ago