Report Service

Description

The Report service interface contains functionality to retreive Statistics and Reports for a webcast. - Statistics contains datetime based data - Reports contains datetime independent data for a webcast, module or visitor All methods return an enum value to indicate error or success. See  ReturnCode for the possible values. 

See Also

Methods | Complex Types | Simple Types

Methods

Name	Description
ChartGet	Get a ChartList, a collection of Charts, which itself is a collection of ChartItems
CustomerGet	Get a Customer, containing running totals of  visitors and views
ExcelSend	Request for an Excel report to be sent to Email
FormsGet	Get a collection of Forms
UserGet	Get a User, containing webcast usage statistics
UserSearch	Get a list of UserSummarys based on the specified filters.
VisitorCompletedForm	Tests if a certain form has been completed by a specific visitor
VisitorGet	Get a Visitor, containing detailed reports about visitors
VisitorSearch	Search Visitors by (part of) email address returns a VisitorSummary, for detailed visitor info see: VisitorGet
VisitorWatchedSince	Gets an array of DateTimes, from a specific starting point
WebcastGet	Get a Webcast containing running totals of minutes watched and amount of viewers for a specified period of time
WebcastSearch	Get a collection of WebcastSummarys
WebcastSummaryGet	Get a WebcastSummary, this data can be cached for 1 minute.

Description

Get a ChartList, a collection of Charts, which itself is a collection of ChartItems 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
ObjectType	string	Input	ObjectType for a list of possible values
ObjectIdentifier	string	Input	CustomerCode for ObjectType Customer, WebcastKey for Webcast, Guid for Form
Start	dateTime	Input	Specifies a starting point for gathering timed information
Period	Period	Input	Used for calculating an end point for gathering timed information. This period is added to Start
ChartTypes	string	Input	A comma delimeted list of chart type names from Charts, where "Chart" will be appended to the type name
PageSize	int	Input	Used for paginating Chart results
PageNumber	int	Input	Used for paginating Chart results
Charts	Charts	Output	A ChartList

Returns

A ChartGetResult element.

Description

Get a Customer, containing running totals of  visitors and views 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
CustomerCode	string	Input	Code used to identify a customer
Start	dateTime	Input	Specifies a starting point for gathering running totals
Period	Period	Input	Used for calculating an end point for gathering running totals. This period is added to Start
Customer	Customer	Output	a Customer, or null if not found

Returns

A CustomerGetResult element.

Description

Request for an Excel report to be sent to Email

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
Email	string	Input	a valid email address

Returns

A ExcelSendResult element.

Description

Get a collection of Forms

Parameters

Name	Type	Direction	Description
UserName	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
Forms	Forms	Output	A collection of Forms

Returns

A FormsGetResult element.

Description

Get a User, containing webcast usage statistics 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
CustomerUserName	string	Input	Uniquely identies a User
User	User	Output	A User

Returns

A UserGetResult element.

Description

Get a list of UserSummarys based on the specified filters. 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
CustomerCode	string	Input	Code used to identify a customer, returns InvalidInput when not a null or empty
UserNameFilter	string	Input	(part of) the user's name
UserUsernameFilter	string	Input	(part of) the user's username
UserEmailFilter	string	Input	(part of) a valid emailaddress
UserTagsFilter	TagList	Input	a collection of Tags
PageSize	int	Input	Used for paginating results
PageNumber	int	Input	Used for paginating results
Order	UserOrdering	Input	Orders the results
UserSummaries	UserSummaryList	Output	a list of UserSummarys

Returns

A UserSearchResult element.

Description

Tests if a certain form has been completed by a specific visitor 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
VisitorId	string	Input	Uniquely identifies a Visitor
FormId	string	Input	Uniquely identifies a Form
Answered	boolean	Output	true if answered

Returns

A VisitorCompletedFormResult element.

Description

Get a Visitor, containing detailed reports about visitors 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
VisitorId	string	Input	Uniquely identifies a Visitor
Start	dateTime	Input	Specifies a starting point for gathering timed information
Period	Period	Input	Used for calculating an end point for gathering timed information. This period is added to Start
Visitor	Visitor	Output	A Visitor, or null if not found

Returns

A VisitorGetResult element.

Description

Search Visitors by (part of) email address returns a VisitorSummary, for detailed visitor info see: VisitorGet

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
Email	string	Input	(part of) an emailadress used for searching
Start	dateTime	Input	Specifies a starting point for gathering timed information
Period	Period	Input	Used for calculating an end point for gathering timed information. This period is added to Start
PageSize	int	Input	Used for paginating results
PageNumber	int	Input	Used for paginating results
Ordering	VisitorOrderByList	Input	Used to order results
VisitorSummaries	VisitorSummaries	Output	a collection of VisitorSummary

Returns

A VisitorSearchResult element.

Description

Gets an array of DateTimes, from a specific starting point 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
VisitorId	string	Input	Uniquely identifies a Visitor
From	dateTime	Input	Specifies a starting point for gathering timed information
Watched	ArrayOfdateTime	Output	An array of DateTime

Returns

A VisitorWatchedSinceResult element.

Description

Get a Webcast containing running totals of minutes watched and amount of viewers for a specified period of time 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
Start	dateTime	Input	Specifies a starting point for gathering running totals
Period	Period	Input	Used for calculating an end point for gathering running totals. This period is added to Start
Filter	WebcastFilter	Input	Use WebcastFilter to retrieve only specific report data (such as poll)
Webcast	Webcast	Output	A Webcast, or null if not found

Returns

A WebcastGetResult element.

Description

Get a collection of WebcastSummarys 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
CustomerCode	string	Input	Code used to identify a customer
Title	string	Input	(part of) a webcast title
Tags	TagList	Input	a collection of Tags
PageSize	int	Input	Used for paginating results
PageNumber	int	Input	Used for paginating results
Order	WebcastOrdering	Input	Orders the results
WebcastSummaries	WebcastSummaryList	Output	a collection of WebcastSummarys, or null if not found

Returns

A WebcastSearchResult element.

Description

Get a WebcastSummary, this data can be cached for 1 minute. 

Parameters

Name	Type	Direction	Description
Username	string	Input	Username used for authentication
Password	string	Input	Password used for authentication
WebcastCode	string	Input	Webcast Code, consisting of CustomerName/YYYYMMDD_serialnumber
WebcastSummary	WebcastSummary	Output	A WebcastSummary, or null if not found

Returns

A WebcastSummaryGetResult element.

Complex Types

Name	Description
Activity	Describes occurance activity for a certain item Examples: - A webcast usually occurs once (Total=1) and has a Duration - A speaker can occur multiple times (Total=n) in a webcast and has a (total)Duration and the average speaking time for a speaker in a webcast = Duration/Total
Answer	A form anwser from a web visitor
Answers	A collection of Answers
ArrayOfdateTime
Chart	Chart data class
ChartItem	Data class for retreiving a simple lightweight sortable item - Id refers to the full item for more details. - Value holds the requested chartvalue, for example: number of downloads
ChartItems	A collection of ChartItems
Charts	A collection of Charts
Customer	Describes Customer usage statistics
Download	Describes download statistics
Downloads	A collecion of Downloads
Form	Contains a collection of Questions
Forms	A Collection of Forms
MediaStream	Describes MediaStream usage statistics
MediaStreams	A collection of MediaStreams
Name	Describes a person's name
Option	A form question Option
Options	A collection of Options
Question	A Survey or poll question containing: -all possible answers (if multiple choice) -correct answers -given answers by visitors
Questions	A collection of Questions
Session	Describes Web visitor session statistics
Sessions	A collection of Sessions
SessionTotal	Describes Web visitor session statistics
Settings	A collection of Strings used to store user settings
Span	A collection of SpanParts
SpanPart	Holds an amount over a span of time Used for generating graphs (that contains multiple SpanParts)
TagList	A collection of Strings used to classify a webcast
User	Describes a user's usage statistics
UserDetails	Describes a user's name, email and username
UserSummary	Describes a user
UserSummaryList	A collection of UserSummarys
Views	Describes views on a webcast element Examples: - a Topic is viewed by 20 visitors (Viewers=20) over 23 sessions (Total=23) The combined duration that an item is viewed is 46 minutes (Duration=46) The average view duration for this topic =  Duration/Total = 2 minutes per session
Visitor	Describes extended visitor usage statistics
VisitorOrderByList	A collection of VisitorOrderBys
VisitorSummaries	A collection of VisitorSummarys
VisitorSummary	Describes visitor usage statistics
Webcast	Describes webcast usage statistics
WebcastDetails	Describes a webcast
WebcastSummary	Describes concise webcast usage statistics
WebcastSummaryList
WebcastUserSummary	Describes user webcast statistics
WebcastUserSummaryList	A collection of WebcastUserSummarys

Description

Describes occurance activity for a certain item Examples: - A webcast usually occurs once (Total=1) and has a Duration - A speaker can occur multiple times (Total=n) in a webcast and has a (total)Duration and the average speaking time for a speaker in a webcast = Duration/Total

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Duration	long	The total amount of time spent during this activity	No
Total	int	Counts the amount of times activity has been registered	No

Description

A form anwser from a web visitor

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Date	dateTime		No
Label	string		Yes
Value	string		Yes
VisitorId	string		Yes

Description

A collection of Answers

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Answer	Answer		Yes

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
dateTime	dateTime		No

Description

Chart data class

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Items	ChartItems		Yes
Type	string		Yes

Description

Data class for retreiving a simple lightweight sortable item - Id refers to the full item for more details. - Value holds the requested chartvalue, for example: number of downloads

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Id	string		Yes
Title	string		Yes
Value	long		No

Description

A collection of ChartItems

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
ChartItem	ChartItem		Yes

Description

A collection of Charts

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Chart	Chart		Yes

Description

Describes Customer usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Activity	Activity		Yes
DownloadsTotal	int	The total amount of downloads	No
Id	string	This customer's id	Yes
Title	string	This customer's title	Yes
Views	Views		Yes

Description

Describes download statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Id	string		Yes
Title	string		Yes
Type	string		Yes
Views	Views		Yes

Description

A collecion of Downloads

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Download	Download		Yes

Description

Contains a collection of Questions

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Id	guid		No
Questions	Questions		Yes
Title	string		Yes
Type	string		Yes

Description

A Collection of Forms

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Form	Form		Yes

Description

Describes MediaStream usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Activity	Activity		Yes
Id	string		Yes
Live	boolean	Is this a live stream?	No
Title	string		Yes
Views	Views		Yes

Description

A collection of MediaStreams

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
MediaStream	MediaStream		Yes

Description

Describes a person's name

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
First	string		Yes
Last	string		Yes
Middle	string		Yes
Title	string		Yes

Description

A form question Option

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Id	guid		No
IsCorrect	boolean		No
Text	string		Yes
Total	int		No

Description

A collection of Options

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Option	Option		Yes

Description

A Survey or poll question containing: -all possible answers (if multiple choice) -correct answers -given answers by visitors

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Answers	Answers		Yes
Id	guid		No
Mandatory	boolean		No
Options	Options		Yes
Text	string		Yes
Type	string		Yes

Description

A collection of Questions

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Question	Question		Yes

Description

Describes Web visitor session statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
City	string		Yes
ContinentCode	string		Yes
Country	string		Yes
Domain	string		Yes
End	dateTime		No
Id	string		Yes
IpAddress	string		Yes
Latitude	float		No
Longitude	float		No
PlayerUrl	string		Yes
Referer	string		Yes
Region	string		Yes
Start	dateTime		No
UserAgentString	string		Yes
WatchedAt	ArrayOfdateTime		Yes

Description

A collection of Sessions

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Session	Session		Yes

Description

Describes Web visitor session statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
City	string		Yes
ContinentCode	string		Yes
Country	string		Yes
Domain	string		Yes
End	dateTime		No
Id	string		Yes
IpAddress	string		Yes
Latitude	float		No
Longitude	float		No
PercentageWatched	decimal		No
PlayerUrl	string		Yes
QuestionsIncorrect	int		No
Referer	string		Yes
Region	string		Yes
Start	dateTime		No
UserAgentString	string		Yes

Description

A collection of Strings used to store user settings

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
string	string		Yes

Description

A collection of SpanParts

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
SpanPart	SpanPart		Yes

Description

Holds an amount over a span of time Used for generating graphs (that contains multiple SpanParts)

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Period	Period		No
Start	dateTime		No
Value	int		No

Description

A collection of Strings used to classify a webcast

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
string	string		Yes

Description

Describes a user's usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
UserDetails	UserDetails		Yes
WebcastUserSummaries	WebcastUserSummaryList		Yes

Description

Describes a user's name, email and username

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Email	string		Yes
Name	Name		Yes
UserName	string		Yes

Description

Describes a user

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Details	UserDetails		Yes
Subscribed	int		No
Visited	int		No

Description

A collection of UserSummarys

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
UserSummary	UserSummary		Yes

Description

Describes views on a webcast element Examples: - a Topic is viewed by 20 visitors (Viewers=20) over 23 sessions (Total=23) The combined duration that an item is viewed is 46 minutes (Duration=46) The average view duration for this topic =  Duration/Total = 2 minutes per session

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Duration	long		No
From	dateTime		No
Span	Span		Yes
To	dateTime		No
Total	int		No
Viewers	int		No
Visitors	int		No

Description

Describes extended visitor usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Downloads	Downloads		Yes
Email	string		Yes
Forms	Forms		Yes
Id	string		Yes
Sessions	Sessions		Yes
UserDetails	UserDetails		Yes
Views	Views		Yes

Description

A collection of VisitorOrderBys

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
VisitorOrderBy	VisitorOrderBy		No

Description

A collection of VisitorSummarys

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
VisitorSummary	VisitorSummary		Yes

Description

Describes visitor usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
DownloadsTotal	int		No
Email	string		Yes
Id	string		Yes
Passed	boolean		No
Session	SessionTotal		Yes
UserDetails	UserDetails		Yes
WatchedLive	boolean		No

Description

Describes webcast usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Activity	Activity		Yes
ActualEnd	dateTime		Yes
ActualStart	dateTime		Yes
ChatQuestions	int		No
Code	string		Yes
Id	string		Yes
LogModifiedAt	dateTime		No
MediaStreams	MediaStreams		Yes
ModifiedAt	dateTime		No
Subscribed	int		No
Title	string		Yes
Views	Views		Yes

Description

Describes a webcast

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
ActualEnd	dateTime		Yes
ActualStart	dateTime		Yes
Code	string		Yes
Title	string		Yes

Description

Describes concise webcast usage statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
Details	WebcastDetails		Yes
Sessions	int		No
Subscribers	int		No
Tags	TagList		Yes
Viewers	int		No

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
WebcastSummary	WebcastSummary		Yes

Description

Describes user webcast statistics

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
MinutesWatched	int		No
Settings	Settings		Yes
UniqueMinutesWatched	int		No
VisitorId	string		Yes
Webcast	WebcastDetails		Yes

Description

A collection of WebcastUserSummarys

Content Model

Contains elements as defined in the following table.

Component	Type	Description	Nillable?
WebcastUserSummary	WebcastUserSummary		Yes

Simple Types

Name	Description
duration
Period	Defines a time span
ReturnCode	The return code indicates failure or success on a method call. A possitive error indicates a client side error which needs an action by the client to resolve the error. A negative error indicates a server side error. A client does not need to do a specific task except to retry the action. Zero indicates success.
UserOrdering	Used to order user queries
VisitorOrderBy	Used to order visitor queries
WebcastFilter	Filter for finetuning results
WebcastOrdering	Used to order webcast queries

Restrictions

• Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?

• The value must be greater than or equal to -P10675199DT2H48M5.4775808S.

• The value must be less than or equal to P10675199DT2H48M5.4775807S.

Description

Defines a time span

Enumeration

Value	Description
All	All time periods
Year	Year period
Month	Month period
Day	Day period
Hour	Hour period
Minute	Minute period

Description

The return code indicates failure or success on a method call. A possitive error indicates a client side error which needs an action by the client to resolve the error. A negative error indicates a server side error. A client does not need to do a specific task except to retry the action. Zero indicates success.

Enumeration

Value	Description
ServerError	Unknown error caused on server.
Success	Completed successfully.
ClientNotAuthorizedOrUnkown	Username/password combination incorrect, unknown or not authorized.
NoData	This data document is not available.
InvalidInput
InvalidChartForObject	Chart either unknown or not supported for supplied objecttype

Description

Used to order user queries

Enumeration

Value	Description
UserNameAsc	sort by user name ascending
UserNameDesc	sort by user name descending
VisitedAsc	sort by visited ascending
VisitedDesc	sort by visited descending
SubscribedAsc	sort by subscribed ascending
SubscribedDesc	sort by subscribed descending

Description

Used to order visitor queries

Enumeration

Value	Description
PercentageWatchedDesc
PercentageWatchedAsc
SessionFromAsc
SessionFromDesc
SessionToAsc
SessionToDesc
VisitorIdDesc
VisitorIdAsc
TotalMinutesViewedDesc
TotalMinutesViewedAsc
QuestionsIncorrectDesc
QuestionsIncorrectAsc
EmailAsc
EmailDesc
DomainAsc
DomainDesc
ContinentCodeAsc
ContinentCodeDesc
RegionAsc
RegionDesc
CountryAsc
CountryDesc
CityAsc
CityDesc
LongitudeAsc
LongitudeDesc
LatitudeAsc
LatitudeDesc
IpAddressAsc
IpAddressDesc
RefererAsc
RefererDesc
PlayerUrlAsc
PlayerUrlDesc
UserAgentStringAsc
UserAgentStringDesc
WatchedLiveAsc
WatchedLiveDesc

Description

Filter for finetuning results

Enumeration

Value	Description
MediaStreams

Description

Used to order webcast queries

Enumeration

Value	Description
CodeAsc
CodeDesc
TitleAsc
TitleDesc
SubscribersAsc
SubscribersDesc
StartAsc
StartDesc
ViewersAsc
ViewersDesc