Recommended Report Creation Workflow – API Help Center

This article describes a recommended method for generating an ad-hoc and scheduled report request.

Follow this procedure to streamline report generation:

Procedure

Generate a report using the Save and Execute command.
- Sandbox: POST https://api.uat.dev.sizmek.com/rest/ReportBuilder/reports/saveAndExecute
- Production: POST https://api.sizmek.com/rest/ReportBuilder/reports/saveAndExecute
Use the Analytics Reporting feature in Amazon Ad Server (AAS) to generate the body of the report in JSON. (For more information, see Generate an Aggregated Report and About Analytics Reporting. (Note that you need AAS credentials to access this article.)

Scroll to the API Object. This object contains a JSON report request according to your report selections.

The following is an example of the API generated by the Analytics Reporting feature for an ad-hoc report:

{
  "entities": [
    {
      "type": "AnalyticsReport",
      "reportName": "test",
      "reportScope": {
        "entitiesHierarchy": {
          "entitiesHierarchyLevelType": "ACCOUNT",
          "accounts": [
            1234567890 
          ],
          "advertisers": [],
          "campaigns": [],
          "sites": []
        },
        "attributionModelID": 0,
        "impressionCookieWindow": 0,
        "clickCookieWindow": 0,
        "filters": {},
        "currencyOptions": {
          "type": "Custom",
          "defaultCurrency": 4,
          "targetCurrency": 4,
          "currencyExchangeDate": "2019-12-06"
        },
        "timeRange": {
          "timeZone": "US/Eastern",
          "type": "Custom",
          "dataStartTimestamp": "2019-12-04T21:00:00.000Z",
          "dataEndTimestamp": "2019-12-05T20:59:59.999Z"
        },
        "presetId": null
      },
      "reportStructure": {
        "attributeIDs": [
          "Campaign ID"
        ],
        "metricIDs": [
          "Served Impressions",
          "Ad Request",
          "CTR"
        ],
        "attributeIDsOnColumns": [],
        "timeBreakdown": "Day"
      },
      "reportExecution": {
        "type": "Ad_Hoc"
      },
      "reportDeliveryMethods": [
        {
          "type": "URL",
          "exportFileType": "JSON",
          "compressionType": "NONE",
          "emailRecipients": [
            "Jane.Smith@sizmek.com"
          ],
          "exportFileNamePrefix": "test"
        }
      ],
      "reportAuthorization": {
        "type": "mm3",
        "userID": 1234567890
      }
    }
  ]
}

Copy the report request into your API execution tool and create the report.
While an ad-hoc report runs, you can use the execution ID to check its status. Continue to check until the status is Finished.
- Sandbox: GET https://api.uat.dev.sizmek.com/rest/ReportBuilder/reports/executions/{executionId}
- Production: GET https://api.sizmek.com/rest/ReportBuilder/reports/executions/{executionID}
Important

Important: Do not run this request more than once per minute.
When the status is Finished, you can download the report from the URL in the response.

For a scheduled report you must define the schedule when the report should run.

Sandbox: POST https://api.uat.dev.sizmek.com/rest/ReportBuilder/reports/saveAndExecute
Production: POST https://api.sizmek.com/rest/ReportBuilder/reports/saveAndActivate

The following is an example of the API generated by the Analytics Reporting feature for a scheduled report:

{
  "entities": [
        {
    "type": "AnalyticsReport",
    "reportName": "scheduled test",
    "reportScope": {
      "entitiesHierarchy": {
        "entitiesHierarchyLevelType": "ACCOUNT",
        "accounts": [
          1234567890
        ],
        "advertisers": [],
        "campaigns": [],
        "sites": []
      },
      "attributionModelID": 0,
      "impressionCookieWindow": 0,
      "clickCookieWindow": 0,
      "filters": {},
      "currencyOptions": {
        "type": "Day of report generation",
        "defaultCurrency": 4,
        "targetCurrency": 4
      },
      "timeRange": {
        "type": "Yesterday",
        "timeZone": "US/Eastern"
      },
      "presetId": null
    },
    "reportStructure": {
      "attributeIDs": [
        "Campaign ID"
      ],
      "metricIDs": [
        "Total Clicks"
      ],
      "attributeIDsOnColumns": [],
      "timeBreakdown": "Day"
    },
    "reportExecution": {
      "type": "Scheduled",
      "startTimestamp": "2019-12-01T13:51:27.551Z",
      "cronExpression": "0 0 4 * * ? *",
      "endTimestamp": "2019-12-03T21:59:00.000Z",
      "timeZone": "US/Eastern"
    },
    "reportDeliveryMethods": [
      {
        "type": "URL",
        "exportFileType": "JSON",
        "compressionType": "NONE",
        "emailRecipients": [
          "Jane.Smith@sizmek.com"
        ],
        "exportFileNamePrefix": "scheduled test"
      }
    ],
    "reportAuthorization": {
      "type": "mm3",
      "userID": 1234567891
    }
  }
  ]
}

If you do not want to use the generate tool, you can create your own report request following the structure outline and fields described in Report Object.

Important

Comments