Report

Synopsis

Generate a report.

Syntax

New-Report -Report <String> -ProductFamily <String> -ReportingArea <String> -TimeRange <String> [-Body <Object>] [-Async] [-PageSize <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

New-Report -Report <String> -ProductFamily <String> -ReportingArea <String> -Start <String> -End <String> [-Body <Object>] [-Async] [-PageSize <Int32>] [-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 Get-Report operation, this operation specifies all request data as a request body, and therefore, it's better suited for very large datasets.

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.
`‑Async`	SwitchPipeline input: False Enables the asynchronous flow to get the data. By default, `false`.
`‑Body`	ObjectPipeline input: False A request body, either as a `PSCustomObject` or a string. This parameter supports pipelining.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑End` Conditionally required	StringParameter sets: `Date range`Pipeline 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.
`‑PageSize`	IntPipeline input: False The size of a page in an async query. By default, the page size is the report's maximum number of returned data points, configured by the `dataPointsLimit` setting. If a report doesn't have this setting, the default value is `50000`.
`‑ProductFamily` Required	StringPipeline input: ByPropertyName The area of products.
`‑Report` Required	StringPipeline input: ByPropertyName An individual report name.
`‑ReportingArea` Required	StringPipeline input: ByPropertyName The grouping of reports related to the same area.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑Start` Conditionally required	StringParameter sets: `Date range`Pipeline input: False The start of the reported period as an ISO 8601 timestamp with timezone.
`‑TimeRange` Conditionally required	StringAccepted values: `LAST_15_MINUTES`, `LAST_30_MINUTES`, `LAST_1_HOUR`, `LAST_3_HOURS`, `LAST_6_HOURS`, `LAST_12_HOURS`, `LAST_1_DAY`, `LAST_2_DAYS`, `LAST_1_WEEK`, `LAST_30_DAYS`, `LAST_90_DAYS`Parameter sets: `Time range`Pipeline input: False Predefined time range, either `LAST_15_MINUTES`, `LAST_30_MINUTES`, `LAST_1_HOUR`, `LAST_3_HOURS`, `LAST_6_HOURS`, `LAST_12_HOURS`, `LAST_1_DAY`, `LAST_2_DAYS`, `LAST_1_WEEK`, `LAST_30_DAYS`, or `LAST_90_DAYS`. Use this as an alternative to a more flexible `start` and `end` time range. Support for specific time range values may vary by report type. See the report documentation under Available reports.

Related Links

Updated 10 days ago