Full Report Description

object
Name
string

This is the human-readable name of the report. It is not recognized by any API input.

required
Version
integer

This is the version of the report. See the https://mm-reports.api-docs.io/v1/metadata/changes-to-report-metadata section for more details.

required
Description
string
URI_Data
string
1 validation + required
1 validation + required
Transition
object

Reports may change over time. This object will be present if the report will undergo a breaking change. See the https://apidocs.mediamath.com/reporting/changes-to-report-metadata section for more details.

Deprecation
object

Reports may be deprecated all together, or superseded by another report. This object will be present if the report is scheduled for deprecation. See the https://apidocs.mediamath.com/reporting/changes-to-report-metadata section for more details.

Type
string
currency
string

Provides information about the currency of the metrics fields typed as “money”.

When set to “campaign currency”, the currency varies from record to record. To determine the currency for a particular record, the campaign_currency_code dimensions field should be requested, if available for the report.

Any other value should be taken to be the currency for all records of the report.

data_retention
string

Indicates how far back data is available. This can be a date, datetime, or time window as specified by the “time_window” and “Special Time Windows” sections of https://apidocs.mediamath.com/reporting/api-reference. This property should be used very loosely. It may not be accurate. It is meant to give a general idea.

default_metrics
array[string]

This is the list of metrics that will be returned if the metrics parameter is not specified in a call to the https://apidocs.mediamath.com/reporting/api-reference/data-retrieval/get-report.

required
structure
object
required
time_aggregation
string

This property indicates the finest granularity of the time_field. For reports with a time_field of the datetime type, this will be “by_hour”, “by_day”, etc. When the type is interval, this will be “various”.

time_rollups
array[string]

This property indicates the available levels of granularity for the time_field. It lists the valid values of the time_rollup parameter used for the https://apidocs.mediamath.com/reporting/api-reference/data-retrieval/get-report endpoint. For reports with a time_field of the datetime type, this tends to be a combination of “by_hour”, “by_day”, “by_week”, “by_month”, “all”, etc. When the type is interval, this will only include “all”.

required
time_windows
array[string]

Lists the acceptable formats for the time_window parameter used by the https://apidocs.mediamath.com/reporting/api-reference/data-retrieval/get-report. Some values may be used as is, others may need to be modified. For details see the time_window section of https://apidocs.mediamath.com/reporting/api-reference.

required
timezone
string

Provides information about the timezone of the time_field for the report.

When set to “campaign timezone”, the timezone varies from record to record. To determine the currency for a particular record, the campaign_timezone dimensions field should be requested, if available for the report.

Any other value should be taken to be the timezone for all records of the report.