PRODUCT
Follow

entitiesHierarchy 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 internal use) If the field was received in the GET call, include it in the PUT call.

Parameter

Description

Type

Required

Notes

entitiesHierarchyLevelType

Level from which data will be pulled for the report.

String

Optional

Options include:

  • ACCOUNT

  • ADVERTISER

  • CAMPAIGN

accountContext

Parent account with account extensions. Required to validate that accounts requested in the scope of the report are related to this parent account.

Integer

Required/Optional

Required if using multiple accounts.

accounts

List of account IDs.

Array of integer

Required

Possible values: single account ID; multiple accounts not currently supported

advertisers

List of advertiser IDs.

Array of integer

Required

Possible values: multiple, comma-separated values

campaigns

List of campaign IDs.

Array of integer

Optional

Possible values: multiple, comma-separated values

sites

List of site IDs.

Array of integer

Optional

This array should always be empty. If you want to filter by sites, use the filter parameter in the reportScope object.

Object JSON Example

Parent Objects

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

Comments

Powered by Zendesk