Agentivity API

DashboardStatsByOptions

The following routes are available for this service:
GET	/DashboardStats

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel

Namespace Global

    Namespace AgentivityAPI.ServiceModel

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ItemResponse(Of TItem, TReport)
            <DataMember(Order:=1)>
            Public Overridable Property ResponseMetadata As ResponseMetadata

            <DataMember(Order:=2, EmitDefaultValue:=false)>
            Public Overridable Property ResponseReport As TReport

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property ResponseError As AgentivityError
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class Report(Of TItemResponse, TItem)
            <DataMember(Order:=1, EmitDefaultValue:=false)>
            Public Overridable Property Item As TItem
        End Class
    End Namespace

    Namespace AgentivityAPI.ServiceModel.Types

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class AgentivityError
            <DataMember>
            Public Overridable Property ErrorCode As String

            <DataMember>
            Public Overridable Property Message As String

            <DataMember>
            Public Overridable Property StatusCode As String

            <DataMember>
            Public Overridable Property VerboseMessage As String
        End Class

        <DataContract(Name:="BookingsAirConversion", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class BookingsAirConversion
            <DataMember(Order:=10)>
            Public Overridable Property TotalTicketed As Integer

            <DataMember(Order:=20)>
            Public Overridable Property TotalUnticketed As Integer
        End Class

        <DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class CacheMetadata
            <DataMember(Order:=1)>
            Public Overridable Property CachedAt As Date

            <DataMember(Order:=2)>
            Public Overridable Property CacheExpiresAt As Date

            <DataMember(Order:=0)>
            Public Overridable Property IsFromCache As Boolean
        End Class

        <DataContract(Name:="ConsultantPerformance", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ConsultantPerformance
            <DataMember(Order:=10)>
            Public Overridable Property Name As String

            <DataMember(Order:=20)>
            Public Overridable Property Total As Integer
        End Class

        <Flags>
        Public Enum DashboardOptions
            ProblematicBookingsCount = 1
            AirlineTicketingCount = 2
            UnticketedBookingsByTauCount = 4
            MonthlyActivity = 8
            ActiveBookingsAirConversion = 16
            PassengerContacts = 32
            TopConsultants = 64
            MostActiveUsers = 128
            TopReports = 256
            ReportUsageSummary = 512
            OutstandingBookingActionsCount = 1024
        End Enum

        <DataContract(Name:="DashboardStats", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class DashboardStats
            <DataMember(Order:=10)>
            Public Overridable Property ProblematicBookings As ThreeDayCounts

            <DataMember(Order:=20)>
            Public Overridable Property AirlineTicketing As ThreeDayCounts

            <DataMember(Order:=30)>
            Public Overridable Property UnticketedBookingsByTau As ThreeDayCounts

            <DataMember(Order:=34)>
            Public Overridable Property OutstandingBookingActions As ThreeDayCounts

            <DataMember(Order:=40)>
            Public Overridable Property MonthlyActivity As List(Of MonthlyActivityBreakdown)

            <DataMember(Order:=50)>
            Public Overridable Property MostActiveUsers As List(Of UserActivity)

            <DataMember(Order:=60)>
            Public Overridable Property TopConsultants As List(Of ConsultantPerformance)

            <DataMember(Order:=70)>
            Public Overridable Property TopReports As List(Of ReportPerformance)

            <DataMember(Order:=80)>
            Public Overridable Property ActiveBookingsAirConversion As BookingsAirConversion

            <DataMember(Order:=90)>
            Public Overridable Property PassengerElements As List(Of PassengerContactElements)

            <DataMember(Order:=90)>
            Public Overridable Property ReportUsageSummary As List(Of ReportPerformance)

            <DataMember(Order:=200)>
            Public Overridable Property MonthlyActivityFormatted As String

            <DataMember(Order:=210)>
            Public Overridable Property PassengerElementsFormatted As String
        End Class

        <DataContract(Namespace:="schemas.agentivity.com/types")>
        Public Partial Class DashboardStatsByOptions
            Inherits PagingMetadata
            '''<Summary>
            '''UserName in form of an email address
            '''</Summary>
            <DataMember>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Top reports
            '''</Summary>
            <DataMember>
            Public Overridable Property ReportsTop As Integer?

            '''<Summary>
            '''Reports in days span
            '''</Summary>
            <DataMember>
            Public Overridable Property ReportsDaysSpan As Integer?

            '''<Summary>
            '''Top most active users
            '''</Summary>
            <DataMember>
            Public Overridable Property MostActiveUsersTop As Integer?

            '''<Summary>
            '''Most active users in days span
            '''</Summary>
            <DataMember>
            Public Overridable Property MostActiveUsersDaysSpan As Integer?

            '''<Summary>
            '''Top consultants last days span
            '''</Summary>
            <DataMember>
            Public Overridable Property TopConsultantsLastDaysSpan As Integer?

            '''<Summary>
            '''Options
            '''</Summary>
            <DataMember>
            Public Overridable Property Options As DashboardOptions
        End Class

        <DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class DashboardStatsByOptionsItemResponse
            Inherits ItemResponse(Of DashboardStats, DashboardStatsByOptionsResponseReport)
        End Class

        <DataContract(Name:="DashboardStats", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class DashboardStatsByOptionsResponseReport
            Inherits Report(Of DashboardStatsByOptionsItemResponse, DashboardStats)
        End Class

        <DataContract(Name:="MonthlyActivityBreakdown", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class MonthlyActivityBreakdown
            <DataMember(Order:=10)>
            Public Overridable Property ReportDate As String

            <DataMember(Order:=20)>
            Public Overridable Property MonthlyEvents As Integer

            <DataMember(Order:=30)>
            Public Overridable Property C As Integer

            <DataMember(Order:=40)>
            Public Overridable Property C_Percentage As Single

            <DataMember(Order:=50)>
            Public Overridable Property I As Integer

            <DataMember(Order:=60)>
            Public Overridable Property I_Percentage As Single

            <DataMember(Order:=70)>
            Public Overridable Property T As Integer

            <DataMember(Order:=80)>
            Public Overridable Property T_Percentage As Single

            <DataMember(Order:=90)>
            Public Overridable Property X As Integer

            <DataMember(Order:=100)>
            Public Overridable Property X_Percentage As Single
        End Class

        <DataContract(Name:="Metadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PagingMetadata
            '''<Summary>
            '''Starting Record
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Starting Record", Name:="Offset", ParameterType:="query")>
            Public Overridable Property Offset As String

            '''<Summary>
            '''Number of records to return (PageSize)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
            Public Overridable Property Limit As String

            '''<Summary>
            '''Total Number of Records in a Full Reponse (if no paging)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Total Number of Records in a Full Reponse (if no paging)", Name:="TotalRecords", ParameterType:="query")>
            Public Overridable Property TotalRecords As Integer

            '''<Summary>
            '''Total Number of Records in this Reponse (on this page)
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Total Number of Records in this Reponse (on this page)", Name:="ResponseRecords", ParameterType:="query")>
            Public Overridable Property ResponseRecords As Integer
        End Class

        <DataContract(Name:="PassengerContactElements", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class PassengerContactElements
            <DataMember(Order:=20)>
            Public Overridable Property DateYear As Integer

            <DataMember(Order:=20)>
            Public Overridable Property DateMonth As Integer

            <DataMember(Order:=30)>
            Public Overridable Property WithMobilePercent As Single

            <DataMember(Order:=40)>
            Public Overridable Property WithEmailPercent As Single

            <DataMember(Order:=50)>
            Public Overridable Property TotalWithMobile As Integer

            <DataMember(Order:=60)>
            Public Overridable Property TotalWithEmail As Integer

            <DataMember(Order:=70)>
            Public Overridable Property TotalCreated As Integer
        End Class

        <DataContract(Name:="ReportPerformance", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ReportPerformance
            <DataMember(Order:=10)>
            Public Overridable Property Name As String

            <DataMember(Order:=20)>
            Public Overridable Property UrlSlug As String

            <DataMember(Order:=30)>
            Public Overridable Property Total As Integer
        End Class

        <DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ResponseMetadata
            <DataMember(Order:=0)>
            Public Overridable Property Success As Boolean

            <DataMember(Order:=1)>
            Public Overridable Property HasCache As Boolean

            <DataMember(Order:=2)>
            Public Overridable Property HasPaging As Boolean

            <DataMember(Order:=3, EmitDefaultValue:=false)>
            Public Overridable Property CacheMetadata As CacheMetadata

            <DataMember(Order:=4, EmitDefaultValue:=false)>
            Public Overridable Property PagingMetadata As PagingMetadata
        End Class

        <DataContract(Name:="ThreeDayCounts", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class ThreeDayCounts
            <DataMember(Order:=10)>
            Public Overridable Property DayPlusZeroTtl As Integer

            <DataMember(Order:=20)>
            Public Overridable Property DayPlusOneTtl As Integer

            <DataMember(Order:=30)>
            Public Overridable Property DayPlusTwoTtl As Integer
        End Class

        <DataContract(Name:="UserActivity", Namespace:="schemas.agentivity.com/types")>
        Public Partial Class UserActivity
            <DataMember(Order:=10)>
            Public Overridable Property UserName As String

            <DataMember(Order:=20)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=30)>
            Public Overridable Property LastName As String

            <DataMember(Order:=40)>
            Public Overridable Property UserID As Integer

            <DataMember(Order:=50)>
            Public Overridable Property UserFrequency As String

            <DataMember(Order:=60)>
            Public Overridable Property ActivityMeasure As Single
        End Class
    End Namespace
End Namespace

VB.NET DashboardStatsByOptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /DashboardStats HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <ProblematicBookings>
        <DayPlusZeroTtl>0</DayPlusZeroTtl>
        <DayPlusOneTtl>0</DayPlusOneTtl>
        <DayPlusTwoTtl>0</DayPlusTwoTtl>
      </ProblematicBookings>
      <AirlineTicketing>
        <DayPlusZeroTtl>0</DayPlusZeroTtl>
        <DayPlusOneTtl>0</DayPlusOneTtl>
        <DayPlusTwoTtl>0</DayPlusTwoTtl>
      </AirlineTicketing>
      <UnticketedBookingsByTau>
        <DayPlusZeroTtl>0</DayPlusZeroTtl>
        <DayPlusOneTtl>0</DayPlusOneTtl>
        <DayPlusTwoTtl>0</DayPlusTwoTtl>
      </UnticketedBookingsByTau>
      <OutstandingBookingActions>
        <DayPlusZeroTtl>0</DayPlusZeroTtl>
        <DayPlusOneTtl>0</DayPlusOneTtl>
        <DayPlusTwoTtl>0</DayPlusTwoTtl>
      </OutstandingBookingActions>
      <MonthlyActivity>
        <MonthlyActivityBreakdown>
          <ReportDate>String</ReportDate>
          <MonthlyEvents>0</MonthlyEvents>
          <C>0</C>
          <C_Percentage>0</C_Percentage>
          <I>0</I>
          <I_Percentage>0</I_Percentage>
          <T>0</T>
          <T_Percentage>0</T_Percentage>
          <X>0</X>
          <X_Percentage>0</X_Percentage>
        </MonthlyActivityBreakdown>
      </MonthlyActivity>
      <MostActiveUsers>
        <UserActivity>
          <UserName>String</UserName>
          <FirstName>String</FirstName>
          <LastName>String</LastName>
          <UserID>0</UserID>
          <UserFrequency>String</UserFrequency>
          <ActivityMeasure>0</ActivityMeasure>
        </UserActivity>
      </MostActiveUsers>
      <TopConsultants>
        <ConsultantPerformance>
          <Name>String</Name>
          <Total>0</Total>
        </ConsultantPerformance>
      </TopConsultants>
      <TopReports>
        <ReportPerformance>
          <Name>String</Name>
          <UrlSlug>String</UrlSlug>
          <Total>0</Total>
        </ReportPerformance>
      </TopReports>
      <ActiveBookingsAirConversion>
        <TotalTicketed>0</TotalTicketed>
        <TotalUnticketed>0</TotalUnticketed>
      </ActiveBookingsAirConversion>
      <PassengerElements>
        <PassengerContactElements>
          <DateMonth>0</DateMonth>
          <DateYear>0</DateYear>
          <WithMobilePercent>0</WithMobilePercent>
          <WithEmailPercent>0</WithEmailPercent>
          <TotalWithMobile>0</TotalWithMobile>
          <TotalWithEmail>0</TotalWithEmail>
          <TotalCreated>0</TotalCreated>
        </PassengerContactElements>
      </PassengerElements>
      <ReportUsageSummary>
        <ReportPerformance>
          <Name>String</Name>
          <UrlSlug>String</UrlSlug>
          <Total>0</Total>
        </ReportPerformance>
      </ReportUsageSummary>
      <MonthlyActivityFormatted>String</MonthlyActivityFormatted>
      <PassengerElementsFormatted>String</PassengerElementsFormatted>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>