ReportService Web 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: ReportService
Method: ChartGet
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.
Method: CustomerGet
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.
Method: ExcelSend
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.
Method: FormsGet
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.
Method: UserGet
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.
Method: UserSearch
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.
Method: VisitorCompletedForm
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.
Method: VisitorGet
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.
Method: VisitorSearch
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.
Method: VisitorWatchedSince
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.
Method: WebcastGet
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.
Method: WebcastSearch
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.
Method: WebcastSummaryGet
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: ReportService
Complex Type: Activity
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 |
|
|
|
|
Complex Type: Answer
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 |
|
|
|
|
Complex Type: Answers
Description
A collection of Answers
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Answer |
Answer |
|
Yes |
|
|
|
|
Complex Type: ArrayOfdateTime
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| dateTime |
dateTime |
|
No |
|
|
|
|
Complex Type: Chart
Description
Chart data class
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Items |
ChartItems |
|
Yes |
| Type |
string |
|
Yes |
|
|
|
|
Complex Type: ChartItem
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 |
|
|
|
|
Complex Type: ChartItems
Description
A collection of ChartItems
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| ChartItem |
ChartItem |
|
Yes |
|
|
|
|
Complex Type: Charts
Description
A collection of Charts
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Chart |
Chart |
|
Yes |
|
|
|
|
Complex Type: Customer
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 |
|
|
|
|
Complex Type: Download
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 |
|
|
|
|
Complex Type: Downloads
Description
A collecion of Downloads
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Download |
Download |
|
Yes |
|
|
|
|
Complex Type: Form
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 |
|
|
|
|
Complex Type: Forms
Description
A Collection of Forms
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Form |
Form |
|
Yes |
|
|
|
|
Complex Type: MediaStream
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 |
|
|
|
|
Complex Type: MediaStreams
Description
A collection of MediaStreams
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| MediaStream |
MediaStream |
|
Yes |
|
|
|
|
Complex Type: Name
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 |
|
|
|
|
Complex Type: Option
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 |
|
|
|
|
Complex Type: Options
Description
A collection of Options
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Option |
Option |
|
Yes |
|
|
|
|
Complex Type: Question
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 |
|
|
|
|
Complex Type: Questions
Description
A collection of Questions
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Question |
Question |
|
Yes |
|
|
|
|
Complex Type: Session
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 |
|
|
|
|
Complex Type: Sessions
Description
A collection of Sessions
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| Session |
Session |
|
Yes |
|
|
|
|
Complex Type: SessionTotal
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 |
|
|
|
|
Complex Type: Settings
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 |
|
|
|
|
Complex Type: Span
Description
A collection of SpanParts
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| SpanPart |
SpanPart |
|
Yes |
|
|
|
|
Complex Type: SpanPart
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 |
|
|
|
|
Complex Type: TagList
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 |
|
|
|
|
Complex Type: User
Description
Describes a user's usage statistics
Content Model
Contains elements as defined in the following table.
Complex Type: UserDetails
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 |
|
|
|
|
Complex Type: UserSummary
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 |
|
|
|
|
Complex Type: UserSummaryList
Description
A collection of UserSummarys
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| UserSummary |
UserSummary |
|
Yes |
|
|
|
|
Complex Type: Views
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 |
|
|
|
|
Complex Type: Visitor
Description
Describes extended visitor usage statistics
Content Model
Contains elements as defined in the following table.
Complex Type: VisitorOrderByList
Description
A collection of VisitorOrderBys
Content Model
Contains elements as defined in the following table.
Complex Type: VisitorSummaries
Description
A collection of VisitorSummarys
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| VisitorSummary |
VisitorSummary |
|
Yes |
|
|
|
|
Complex Type: VisitorSummary
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 |
|
|
|
|
Complex Type: Webcast
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 |
|
|
|
|
Complex Type: WebcastDetails
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 |
|
|
|
|
Complex Type: WebcastSummary
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 |
|
|
|
|
Complex Type: WebcastSummaryList
Content Model
Contains elements as defined in the following table.
| Component |
Type |
Description |
Nillable? |
| |
|
|
|
| WebcastSummary |
WebcastSummary |
|
Yes |
|
|
|
|
Complex Type: WebcastUserSummary
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 |
|
|
|
|
Complex Type: WebcastUserSummaryList
Description
A collection of WebcastUserSummarys
Content Model
Contains elements as defined in the following table.
Simple Types: ReportService
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
|
Simple Type: duration
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.
Simple Type: Period
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
|
Simple Type: ReturnCode
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
|
Simple Type: UserOrdering
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
|
Simple Type: VisitorOrderBy
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 |
|
Simple Type: WebcastFilter
Description
Filter for finetuning results
Enumeration
| Value |
Description |
| MediaStreams |
|
Simple Type: WebcastOrdering
Description
Used to order webcast queries
Enumeration
| Value |
Description |
| CodeAsc |
|
| CodeDesc |
|
| TitleAsc |
|
| TitleDesc |
|
| SubscribersAsc |
|
| SubscribersDesc |
|
| StartAsc |
|
| StartDesc |
|
| ViewersAsc |
|
| ViewersDesc |
|