Report Object – API Help Center

Endpoints Using the Report Object

Report Resource

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 Amazon Ad Server (AAS) 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

{
  "entities": [
    {
      "type": "AnalyticsReport",
      "reportName": "Test Weekly Report",
      "reportScope": {
        "entitiesHierarchy": {
          "accounts": [
            1234567890
          ],
          "advertisers": [
            1234567891,
            1234567892,
            1234567893
          ],
          "campaigns": [],
          "sites": []
        },
        "attributionModelID": -1,
        "impressionCookieWindow": 0,
        "clickCookieWindow": 0,
        "filters": {},
        "timeRange": {
          "type": "Yesterday",
          "timeZone": "US/Eastern"
        },
        "currencyOptions": {
          "type": "1st of the month",
          "defaultCurrency": 4,
          "targetCurrency": 1
        }
      },
      "reportStructure": {
        "attributeIDs": [],
        "metricIDs": [
          "Total Media Cost",
          "Total Profit",
          "Conversion Revenue",
          "Total Conversions",
          "Clicks (Gross)",
          "Clicks (SIVT)",
          "Average Video Percentage Complete (%)"
        ],
        "attributeIDsOnColumns": [],
        "timeBreakdown": "Month"
      },
      "reportExecution": {
        "type": "Scheduled",
        "startTimestamp": "2018-08-26T21:00:00.000Z",
        "endTimestamp": "2018-11-27T12:13:04.414Z",
        "cronExpression": "0 0 4 ? * 2 *",
        "timeZone": "US/Eastern"
      },
      "reportDeliveryMethods": [
        {
          "type": "Email",
          "exportFileType": "Excel",
          "compressionType": "NONE",
          "exportFileNamePrefix": "Test Weekly Report",
          "emailRecipients": [
            "Jane.Smith@sizmek.com"
          ]
        }
      ],
      "reportAuthorization": {
        "type": "mm3",
        "userID": 1234567890
      }
    }
  ]
}

Child Objects

reportScope Object

reportScope 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.

Parameter	Description	Type	Required	Notes
entitiesHierarchy	Entities included in the report.	entitiesHierarchy Object	Required
attributionModelID	Conversion metric settings	Integer	Required	View attributionModelID values -1: Primary 0: None 1: Last event (impression or click) 2: Click over impression 3: Last click (disregard impressions) 4: Last event (filter out non-viewable) 5: Last event (prefer viewable impressions over non-viewable impressions) 6: Click over impression (filter out non-viewable) 7: Click over impression (prefer viewable impressions over non-viewable impressions) Note Notes: Set to 0 if not using conversion metrics. These values are omitted if you are not using any conversion metric in your report. -1 (Primary) must be set when choosing an account level, multiple advertisers, or campaigns from multiple advertisers (any level that might include more than one advertiser).
impressionCookieWindow	Window of time (in days) that includes the user actions (impressions or clicks) relevant to the path to conversion.	Integer	Required	Possible values: 0-90 Set to 0 if not using conversion metrics. These values are omitted if you are not using any conversion metric in your report.
clickCookieWindow		Integer	Required
filters	Name of filter for the report.	String	Optional	View filter values Site Conversion Tag Name Ad Placement Panel Video Asset Custom Interactions Category Note Note: The Video Asset filter and Custom Interactions filter are available when you select the Video/Audio Asset dimension or Custom Interaction dimension respectively.
timeRange	Includes the mode of time range, time zone, and start/end timestamps.	timeRange Object	Required
currencyOptions	Currency settings for the report.	currencyOptions Object	Required
presetId	Corresponds to the AAS Templates.	Integer	Optional	Set to null if not using this parameter.

Object JSON Example

"reportScope": {
        "entitiesHierarchy": {
          "entitiesHierarchyLevelType": "ACCOUNT",
          "accounts": [
            1234567890
          ],
          "advertisers": [
            1234567891,
            1234567892,
            1235467893
          ],
          "campaigns": [],
          "sites": []
        },
        "attributionModelID": 1,
        "impressionCookieWindow": 30,
        "clickCookieWindow": 30,
        "filters": {
          "placementIds": [
            1234567894
          ],
          "sites": [
            1234567895
          ],
          "conversionTagIDs": [
            1234567896,
            1234567897,
            1234567898
          ],
          "adIds": [
            1234567899,
            1234567880,
            1234567881
          ],
          "customInteractionIds": [
            1234567891234567,
            2345678902345678
          ]
        },
        "currencyOptions": {
          "type": "Custom",
          "defaultCurrency": 4,
          "targetCurrency": 4,
          "currencyExchangeDate": "2019-12-19"
        },
        "timeRange": {
          "type": "Yesterday",
          "timeZone": "US/Eastern"
        },
        "presetId": null
      },

Child Objects

Parent Objects

Report Object

Endpoints Using the Report Object

Report Object Definition

Note

Note

Object JSON Example

Child Objects

reportScope Object

reportScope Object Definition

Note

Note

Note

Object JSON Example

Child Objects

Parent Objects

Comments