Developer's Guide

Gateway Reporting Developer Guide 9
1
Reporting Overview
The Reporting API is an API that you can use to automate your report queries. It allows you to
programmatically query in XML the Reporting database.
PayPal Manager is also a client of the Reporting API. Everything that Manager can do with
reports is available to you through API calls. You can, for example, request a particular report
be run within a specified date range. The response returns all the data that the report generates.
The reporting engine encapsulates the information in all the Gateway services reports. You can
store this information in your local database and use it as needed.
Operations You Can Perform Using the Reporting API
The Reporting API enables you to perform the following operations:
 Managing report templates
 Running reports on demand by report or report template name
 Obtaining information about reports
 Managing report template schedules
 Performing searches
The standard (predefined) reports supported are described in Appendix C, “Report
Parameters.”
Managing Report Templates
You may want to create report templates based on the reports that are supported. A report
template lets you create an instance of a report. With this instance, you provide a list of
parameters.
Report templates are handy when you find that you frequently need to look up reports based
on the same criteria. You provide the parameters and values once, and Reporting saves this
information with the report template. When you run the report template, you do not need to
provide the parameters a second time.
Report template management enables you to perform all the following tasks:
 Create report templates
 Query report templates in the database
 Retrieve report templates from the database
 Update report templates
 Delete report templates