Report
Get-Report
Synopsis
Get a cacheable report.
Syntax
Get-Report -Name <String> -Version <String> -Start <String> -End <String> [-ObjectIDs <String>] -Interval <String> [-Filters <String>] [-Metrics <String>] [-Limit <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-Report -Name <String> -Version <String> -Start <String> -End <String> [-AllObjectIDs] -Interval <String> [-Filters <String>] [-Metrics <String>] [-Limit <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Produces a report in either JSON or CSV format for a specific version of a report type. While functionally it's identical to the New-Report
operation, this operation specifies all request data as query parameters. It also produces a cacheable result, and therefore, this recursive operation is faster than the New-Report
operation.
Parameters
‑AccountSwitchKey |
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 |
An alternative to |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑End Required |
The end of the reported period as an ISO 8601 timestamp with a timezone. Any data that matches the |
‑Filters |
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 ( |
‑Interval Required |
The duration of each data record, either |
‑Limit |
Limits the number of entries returned. Not supported on all report types. |
‑Metrics |
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 |
The type of report. |
‑ObjectIDs |
An alternative to |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑Start Required |
The start of the reported period as an ISO 8601 timestamp with timezone. |
‑Version Required |
The version of the report type. |
Related Links
Updated 3 days ago