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

{
  "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

Endpoints Using the Report Object

Report Object Definition

Note

Note

Object JSON Example

Child Objects

Comments