PRODUCT

Amazon Ad Server will be sunset in Q4 2024, please visit this page (AAS offboarding information) for offboarding support resources and sunset FAQs. Details shared on that page represent the most up to date information in the Help Center, if you find disparate information in other resources please default to the information in the AAS offboarding information page accordingly.

Follow

timeRange Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

For more information, see: Select Timezone for Aggregated Reports. (Note that you need AAS credentials to access this article).

Parameter

Description

Type

Required

Notes

type

Mode of time range definition

String

Required

Possible values for ad hoc reports:

  • Custom

Possible values for scheduled reports:

  • Today

  • Yesterday

  • Last Week

  • This Week

  • Last Month

  • This Month

  • Last 24 Hours

  • Last 7 Days

  • Last 30 Days

  • Campaign Lifetime

Set to Custom if you are running an ad hoc report.

timeZone

Time zone in which the time range will be defined.

String

Required

dataStartTimestamp

For ad-hoc type only.

Definition of the date range used to slice the report's data. The dates should be in ISO 8601 format.

String

Required for ad-hoc reports

1994-11-05T13:15:30Z corresponds to November 5, 1994, 8:15am, US Eastern Standard Time.

dataEndTimestamp

String

Required for ad-hoc reports

Note

Note: When using dataStartTimestamp and dataEndTimestamp, make sure you are taking into account daylight savings time.

Object JSON Example

Parent Objects

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments