Report as a Service

Join the forum:  Report-as-a-Service User Group

About

The service is open to all for inclusion in programs, widgets, and any other application requiring totals from various checkout pages in real-time.

The reporting service provides a summary of account activities. The following two reports are currently available:

1. Account Information
• ac1000
• Organization’s total receipts
2. Social Networking
• sn1000
• Totals of up to 5 trackers
3. Social Comments
• sc1000
• Last 20 social comments for the listed tracker
4. Themometer
•  tm1000
• Total from one tracker

The report families are designed to provide the required information for a family of widgets that are being designed. 

Activation

As a security measure, the reporting service should be activated prior to use.  The service will report NULL values if it is not activated.

To activate the reporting service follow the steps listed below:

• Login to the administrative system:  https://admin.co.clickandpledge.com
• Click on Account Info
• Click on API in the Profile tab
• Scroll down and check the “Enable Reporting Services (RaaS)”

Trackers

Trackers may be added to any payment page link. Each checkout page, by default, follows the following URL format:

• https://co.clickandpledge.com/default.aspx?WID=27959

 Where:

WID = Window ID as provided for each checkout page in the administrative system / Checkout pages link in the toolbar.

A tracker may be added to the end of any URL by adding the following parameter to the end of each checkout page URL.

• https://co.clickandpledge.com/default.aspx?WID=27959&trk=John2009
• https://co.clickandpledge.com/default.aspx?WID=27959&trk=Mary2009062

The trk variable is a text as set freely without any changes to the checkout page in the administrative system. The reporting service offers totals for each tracker.

All reports may be queried based on the following base URL. [RaaS responds to both https & http requests for convenience] 

· https://raas.cloud.clickandpledge.com/report/AccountID/ReportKey/ReportName/BeginningDate/EndDate/

· http://raas.cloud.clickandpledge.com/report/AccountID/ReportKey/ReportName/BeginningDate/EndDate/

RaaS Format & Calling Arguments

• AccountID: Account number as given in the Administrative System / Account Info / Your Profile
• ReportKey: Report Key as given in the Administrative System / Your Profile / 3^rd Party
• ReportName: sn1000 for social networking report and tm1000 for thermometer report.
• BeginningDate: The beginning date for the tracker total. The beginning date format is based on YYYYMMDD. If beginning date is set to 0, the start date will be from the time zero.
• EndDate: The end date for the tracker total. End date format is based on YYYYMMDD. If end date is set to 0, the end date will be as of the current date & time (“now”).

Each report type serves a specific purpose. It is highly recommended that reports best suitable for the application be used to increase efficiency of the reporting system.

The following information is listed in the examples listed below:

• AccountID: 14521
• Report Key: 1dfbb59556f945618867