Developer's Guide

Reporting Developer’s Guide 13
Using the Reporting API
Running Reports
2
Running a Report and Obtaining Report Data
This procedure describes how to run a report and how to obtain the data in that report.
Step 1. Run the report
To run a report, call runReportRequest, providing the following parameter
information.
runReportRequest(reportName, reportParams, pageSize)
The runReportResponse returns the reportId. The reportId is used to refer to the
particular report in future requests.
Step 2. Get the metadata
To get information on how the report is formatted, call getMetaDataRequest, providing
the ReportId returned when the report was run.
getMetaDataRequest(ReportId)
getMetaDataResponse returns the following data.
Step 3. Get the report data
To get the actual data in the report, call getDataRequest with the following parameters.
getDataRequest(reportId, pageNum)
Parameter Description
reportName Name of the report, for example, DailyActivityReport.
reportParam(s) (Optional) paramName and paramValue for each request input
param to be assigned a value.
pageSize Number of rows of data per page. Default is 50.
Parameter Description
numberOfRows Total number of rows.
numberOfPages Total number of pages in the report.
pageSize Page size.
numberOfColumns Total number of columns.
dataName Name of each column.
dataType Type of column data, for example, string.
reportId ID returned for this report returned by runReportRequest.
pageNum Report page number containing data to be returned.