Guide

Report

New-Report

Suggest Edits

Synopsis

Generate a report.

Syntax

New-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>]

New-Report -Name <String> -Version <String> -Start <String> -End <String> -Interval <String> -Body <Object> [-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 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
String Pipeline 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
Object Parameter sets: postbody Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑End
Required
String 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.
‑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
String Accepted 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.
‑Limit
String Pipeline input: False

Limits the number of entries returned. Not supported on all report types.
‑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
String Pipeline input: False

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
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Start
Required
String Pipeline input: False

The start of the reported period as an ISO 8601 timestamp with timezone.
‑Version
Required
String Pipeline input: False

The version of the report type.

Related Links

User Guide: Reporting

Updated 2 days ago