| GET | /DashboardStats |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class DashboardStatsByOptions : PagingMetadata()
{
/**
* UserName in form of an email address
*/
@DataMember
open var UserName:String? = null
/**
* Top reports
*/
@DataMember
open var ReportsTop:Int? = null
/**
* Reports in days span
*/
@DataMember
open var ReportsDaysSpan:Int? = null
/**
* Top most active users
*/
@DataMember
open var MostActiveUsersTop:Int? = null
/**
* Most active users in days span
*/
@DataMember
open var MostActiveUsersDaysSpan:Int? = null
/**
* Top consultants last days span
*/
@DataMember
open var TopConsultantsLastDaysSpan:Int? = null
/**
* Options
*/
@DataMember
open var Options:DashboardOptions? = null
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
open var Offset:String? = null
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
open var Limit:String? = null
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
open var TotalRecords:Int? = null
/**
* Total Number of Records in this Reponse (on this page)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
open var ResponseRecords:Int? = null
}
@Flags()
enum class DashboardOptions(val value:Int)
{
@SerializedName("1") ProblematicBookingsCount(1),
@SerializedName("2") AirlineTicketingCount(2),
@SerializedName("4") UnticketedBookingsByTauCount(4),
@SerializedName("8") MonthlyActivity(8),
@SerializedName("16") ActiveBookingsAirConversion(16),
@SerializedName("32") PassengerContacts(32),
@SerializedName("64") TopConsultants(64),
@SerializedName("128") MostActiveUsers(128),
@SerializedName("256") TopReports(256),
@SerializedName("512") ReportUsageSummary(512),
@SerializedName("1024") OutstandingBookingActionsCount(1024),
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class DashboardStatsByOptionsItemResponse : ItemResponse<DashboardStats, DashboardStatsByOptionsResponseReport>()
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
@DataMember(Order=1)
open var ResponseMetadata:ResponseMetadata? = null
@DataMember(Order=2, EmitDefaultValue=false)
open var ResponseReport:TReport? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var ResponseError:AgentivityError? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
@DataMember(Order=0)
open var Success:Boolean? = null
@DataMember(Order=1)
open var HasCache:Boolean? = null
@DataMember(Order=2)
open var HasPaging:Boolean? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var CacheMetadata:CacheMetadata? = null
@DataMember(Order=4, EmitDefaultValue=false)
open var PagingMetadata:PagingMetadata? = null
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
@DataMember(Order=1)
open var CachedAt:Date? = null
@DataMember(Order=2)
open var CacheExpiresAt:Date? = null
@DataMember(Order=0)
open var IsFromCache:Boolean? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
@DataMember
open var ErrorCode:String? = null
@DataMember
open var Message:String? = null
@DataMember
open var StatusCode:String? = null
@DataMember
open var VerboseMessage:String? = null
}
@DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
open class DashboardStats
{
@DataMember(Order=10)
open var ProblematicBookings:ThreeDayCounts? = null
@DataMember(Order=20)
open var AirlineTicketing:ThreeDayCounts? = null
@DataMember(Order=30)
open var UnticketedBookingsByTau:ThreeDayCounts? = null
@DataMember(Order=34)
open var OutstandingBookingActions:ThreeDayCounts? = null
@DataMember(Order=40)
open var MonthlyActivity:ArrayList<MonthlyActivityBreakdown>? = null
@DataMember(Order=50)
open var MostActiveUsers:ArrayList<UserActivity>? = null
@DataMember(Order=60)
open var TopConsultants:ArrayList<ConsultantPerformance>? = null
@DataMember(Order=70)
open var TopReports:ArrayList<ReportPerformance>? = null
@DataMember(Order=80)
open var ActiveBookingsAirConversion:BookingsAirConversion? = null
@DataMember(Order=90)
open var PassengerElements:ArrayList<PassengerContactElements>? = null
@DataMember(Order=90)
open var ReportUsageSummary:ArrayList<ReportPerformance>? = null
@DataMember(Order=200)
open var MonthlyActivityFormatted:String? = null
@DataMember(Order=210)
open var PassengerElementsFormatted:String? = null
}
@DataContract(Name="ThreeDayCounts", Namespace="schemas.agentivity.com/types")
open class ThreeDayCounts
{
@DataMember(Order=10)
open var DayPlusZeroTtl:Int? = null
@DataMember(Order=20)
open var DayPlusOneTtl:Int? = null
@DataMember(Order=30)
open var DayPlusTwoTtl:Int? = null
}
@DataContract(Name="MonthlyActivityBreakdown", Namespace="schemas.agentivity.com/types")
open class MonthlyActivityBreakdown
{
@DataMember(Order=10)
open var ReportDate:String? = null
@DataMember(Order=20)
open var MonthlyEvents:Int? = null
@DataMember(Order=30)
open var C:Int? = null
@DataMember(Order=40)
open var C_Percentage:Float? = null
@DataMember(Order=50)
open var I:Int? = null
@DataMember(Order=60)
open var I_Percentage:Float? = null
@DataMember(Order=70)
open var T:Int? = null
@DataMember(Order=80)
open var T_Percentage:Float? = null
@DataMember(Order=90)
open var X:Int? = null
@DataMember(Order=100)
open var X_Percentage:Float? = null
}
@DataContract(Name="UserActivity", Namespace="schemas.agentivity.com/types")
open class UserActivity
{
@DataMember(Order=10)
open var UserName:String? = null
@DataMember(Order=20)
open var FirstName:String? = null
@DataMember(Order=30)
open var LastName:String? = null
@DataMember(Order=40)
open var UserID:Int? = null
@DataMember(Order=50)
open var UserFrequency:String? = null
@DataMember(Order=60)
open var ActivityMeasure:Float? = null
}
@DataContract(Name="ConsultantPerformance", Namespace="schemas.agentivity.com/types")
open class ConsultantPerformance
{
@DataMember(Order=10)
open var Name:String? = null
@DataMember(Order=20)
open var Total:Int? = null
}
@DataContract(Name="ReportPerformance", Namespace="schemas.agentivity.com/types")
open class ReportPerformance
{
@DataMember(Order=10)
open var Name:String? = null
@DataMember(Order=20)
open var UrlSlug:String? = null
@DataMember(Order=30)
open var Total:Int? = null
}
@DataContract(Name="BookingsAirConversion", Namespace="schemas.agentivity.com/types")
open class BookingsAirConversion
{
@DataMember(Order=10)
open var TotalTicketed:Int? = null
@DataMember(Order=20)
open var TotalUnticketed:Int? = null
}
@DataContract(Name="PassengerContactElements", Namespace="schemas.agentivity.com/types")
open class PassengerContactElements
{
@DataMember(Order=20)
open var DateYear:Int? = null
@DataMember(Order=20)
open var DateMonth:Int? = null
@DataMember(Order=30)
open var WithMobilePercent:Float? = null
@DataMember(Order=40)
open var WithEmailPercent:Float? = null
@DataMember(Order=50)
open var TotalWithMobile:Int? = null
@DataMember(Order=60)
open var TotalWithEmail:Int? = null
@DataMember(Order=70)
open var TotalCreated:Int? = null
}
@DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
open class DashboardStatsByOptionsResponseReport : Report<DashboardStatsByOptionsItemResponse, DashboardStats>()
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
open var Item:TItem? = null
}
Kotlin DashboardStatsByOptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>