PRODUCT
Follow

Endpoints Using the Report Object

Report 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 Sizmek Ad Suite (SAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

type

Type of report to generate.

String

Required

AnalyticsReport

reportName

Name of report.

String

Required

When the report is ready, the name of the report appears as the subject of the email notification.

reportScope

Determines the attribution model and cookie window details, in addition to currency and time range information.

reportScope Object

Required

reportStructure

Determines the dimensions and metrics that will be included in the report.

reportStructure Object

Required

reportExecution

Determines the type (ad-hoc/scheduled) and time that the report will run.

reportExecution Object

Required

reportDeliveryMethods

Determines how the report will be delivered.

reportDeliveryMethods Object

Required

Note

Note: If the delivery method is Email, the email recipients will receive an email message after the report runs successfully. The email message will include either an attachment (for reports that are smaller than 5 MB) or a link (for reports that are larger than 5 MB).

reportAuthorization

Authorization parameters.

reportAuthorization Object

Required

Object JSON Example

Child Objects

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

Comments

Powered by Zendesk