# Reporting API ## **Introduction** The following documentation reviews the REST API for authenticating and accessing Reporting data on the Webcast platform. This API require API credentials to be created for your company. These credentials are used to authenticate your account before you can access Webcast report data. To request an API account, please contact [Support](mailto:support@webcasts.com) for assistance. ## **Authentication** In order to access Webcast reporting data, you must first authenticate using your Webcast API credentials. Below is an exmaple of a **Authentication Request**. After successful authentication, you will be provided with Session ID and User ID that will be used to access reporting data. The bold values in this example need to be updated to include your API Username and Password in the corresponding fields. Refer to the example URL and Parameters below for more details. Contact [Support](mailto:support@webcasts.com) to request an API account. #### **Methods**
**Method Details**
HTTP Methods GET
Content Type text/html
Response Format text/xml or text/json
#### **Base Path** **XML (default):** `https://api.webcasts.com/api/login` **JSON:** `https://api.webcasts.com/api/login/json` #### **Parameters**
**Parameter** **Required** **Description** **Format**
ver Yes API version Always equal to "2.0" Alphanumeric, utf-8
username Yes Reporting admin username Ascii email
password Yes Reporting admin password Alphanumeric, utf-8

**The "ver" parameter is always equal to "2.0"**

#### **Sample Authentication Request** XML Response Format (Python) ```Python import http.client conn = http.client.HTTPSConnection("api.webcasts.com") payload = '' headers = { 'Content-Type': 'text/html' } conn.request("GET", "/api/login?username=USERNAME&password=PASSWORD&ver=2.0", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` JSON Response Format (Python) ```Python import http.client conn = http.client.HTTPSConnection("api.webcasts.com") payload = '' headers = { 'Content-Type': 'text/html' } conn.request("GET", "/api/login/json?username=USERNAME&password=PASSWORD&ver=2.0", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ## **Event ID List Request** Access a list of all webcast event IDs the admin account has has permission to view. The list will include expired webcasts. The expired status is noted in the response. #### **Methods**
**Method Details**
HTTP Methods GET or POST
Content Type text/html
Response Format text/xml, text/json
#### **Base Path** **XML (default):** `https://api.webcasts.com/api/reporting/eventlist` **JSON:** `https://api.webcasts.com/api/reporting/eventlist/json` #### **Parameters**
**Parameter** **Required** **Description** **Format**
si Yes user id Alphanumeric, utf-8
ui Yes session id Alphanumeric, utf-8
#### **Sample Event ID List Request** #### **Sample Event ID List Response** ## **Event Report Request** #### **Methods**
**Method Details**
HTTP Methods GET or POST
Content Type text/html
Response Format text/xml, text/json, or text/csv
#### **Base Path** **XML (default):** `https://api.webcasts.com/api/reporting/audience_reports` **JSON:** `https://api.webcasts.com/api/reporting/audience_reports/json` **CSV:** `https://api.webcasts.com/api/reporting/audience_reports/csv` #### **Parameters**
**Parameter** **Required** **Description** **Format** **Accepted Values**
ver Yes API version Always equal to "2.0" Alphanumeric, utf-8 "2.0"
ui Yes user id Alphanumeric, utf-8 The user id from authentication
si Yes session id Alphanumeric, utf-8 The session id from authentication
ei Yes The 7 digit event id of the webcast the report is requested for Alphanumeric, utf-8 7 digit webcast id
tz No Time Zone for all times displayed in this report. Defaults to GMT if undefined. Alphanumeric, utf-8
date\_range\_start No Start date of the report date range. Timestamp is automatically set to 12:00:00 AM on the selected start date. date date format mm/dd/yyyy
date\_range\_end No End date of the report date range. Timestamp is automatically set to 11:59:59 PM on the selected end date. date date format mm/dd/yyyy
dr\_regs Restricts results by including only registrants who registered within the selected date range. If undefined, it will default to on. Alphanumeric, utf-8 "on", "off"
dr\_sessions Restricts results by including only registrants who have viewing duration of any type within the selected date range. If undefined, it will default to on. Alphanumeric, utf-8 "on", "off"
sti\_filter No Restricts results by including only registrants who accessed the event using a URL containing a Campaign Source Tracking Identifier. If undefined, it will default to off. Separate multiple values with pipe delimiter. Alphanumeric, utf-8
excl\_domain No Restricts results by excluding any registrants with emails on the specified domain. If undefined, it will default to off. Separate multiple values with pipe delimiter. Cannot be used with "incl\_domain". Alphanumeric, utf-8
incl\_domain No Restricts results by including any registrants with emails on the specified domain. If undefined, it will default to off. Separate multiple values with pipe delimiter. Cannot be used with "excl\_domain". Alphanumeric, utf-8
users\_qa No Restricts results by including only registrants who asked a question. If undefined, it will default to off.Alphanumeric, utf-8 "on", "off"
user\_survey No Restricts results by including only registrants who responded to one or more surveys. If undefined, it will default to off.Alphanumeric, utf-8 "on", "off"
no\_shows No Restricts results by including only registrants with no viewing sessions of any type. If undefined, it will default to off.Alphanumeric, utf-8 "on", "off"
live\_viewers No Restricts results by including only registrants with one or more live viewing sessions. If undefined, it will default to off. Alphanumeric, utf-8 "on", "off"
od\_viewers No Restricts results by including only registrants with one or more On-Demand or Archive viewing sessions. If undefined, it will default to off. Alphanumeric, utf-8 "on", "off"
simlive\_viewers No Restricts results by including only registrants with one or more Sim-Live viewing sessions. If undefined, it will default to off. Alphanumeric, utf-8 "on", "off"