API developers use the Sizmek Reporting API to create and execute reports programatically, based on the platform entities. (For more information, see REFERENCE: Valid Attribute-Metric Combinations.)
Reporting API methods allow you to define the report criteria. Note that there are limitations with these methods:
- Reporting API is an asynchronous restful request; you receive a response message, but do not receive the actual report directly.
- You can receive responses in the form of an FTP file or in email.
- The Sizmek Reporting API runs on Sizmek Advertising Suite.
- The reports do not support every dimension and metric. You can use the platform Report Builder to verify available dimensions and metrics or use the Excel for all supported metrics, attributes, and dimensions.
Report API Workflow
Step 1: Create the JSON report request. Click here for a comprehensive example of JSON code.
Step 2: Submit the report request.
Step 3: Review the report in your email, URL link (as an immediate response), or FTP site.