| GET | /DashboardStats |
|---|
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Name="ThreeDayCounts", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ThreeDayCounts() =
[<DataMember(Order=10)>]
member val DayPlusZeroTtl:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val DayPlusOneTtl:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val DayPlusTwoTtl:Int32 = new Int32() with get,set
[<DataContract(Name="MonthlyActivityBreakdown", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type MonthlyActivityBreakdown() =
[<DataMember(Order=10)>]
member val ReportDate:String = null with get,set
[<DataMember(Order=20)>]
member val MonthlyEvents:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val C:Int32 = new Int32() with get,set
[<DataMember(Order=40)>]
member val C_Percentage:Single = new Single() with get,set
[<DataMember(Order=50)>]
member val I:Int32 = new Int32() with get,set
[<DataMember(Order=60)>]
member val I_Percentage:Single = new Single() with get,set
[<DataMember(Order=70)>]
member val T:Int32 = new Int32() with get,set
[<DataMember(Order=80)>]
member val T_Percentage:Single = new Single() with get,set
[<DataMember(Order=90)>]
member val X:Int32 = new Int32() with get,set
[<DataMember(Order=100)>]
member val X_Percentage:Single = new Single() with get,set
[<DataContract(Name="UserActivity", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type UserActivity() =
[<DataMember(Order=10)>]
member val UserName:String = null with get,set
[<DataMember(Order=20)>]
member val FirstName:String = null with get,set
[<DataMember(Order=30)>]
member val LastName:String = null with get,set
[<DataMember(Order=40)>]
member val UserID:Int32 = new Int32() with get,set
[<DataMember(Order=50)>]
member val UserFrequency:String = null with get,set
[<DataMember(Order=60)>]
member val ActivityMeasure:Single = new Single() with get,set
[<DataContract(Name="ConsultantPerformance", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantPerformance() =
[<DataMember(Order=10)>]
member val Name:String = null with get,set
[<DataMember(Order=20)>]
member val Total:Int32 = new Int32() with get,set
[<DataContract(Name="ReportPerformance", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ReportPerformance() =
[<DataMember(Order=10)>]
member val Name:String = null with get,set
[<DataMember(Order=20)>]
member val UrlSlug:String = null with get,set
[<DataMember(Order=30)>]
member val Total:Int32 = new Int32() with get,set
[<DataContract(Name="BookingsAirConversion", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingsAirConversion() =
[<DataMember(Order=10)>]
member val TotalTicketed:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val TotalUnticketed:Int32 = new Int32() with get,set
[<DataContract(Name="PassengerContactElements", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PassengerContactElements() =
[<DataMember(Order=20)>]
member val DateYear:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val DateMonth:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val WithMobilePercent:Single = new Single() with get,set
[<DataMember(Order=40)>]
member val WithEmailPercent:Single = new Single() with get,set
[<DataMember(Order=50)>]
member val TotalWithMobile:Int32 = new Int32() with get,set
[<DataMember(Order=60)>]
member val TotalWithEmail:Int32 = new Int32() with get,set
[<DataMember(Order=70)>]
member val TotalCreated:Int32 = new Int32() with get,set
[<DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type DashboardStats() =
[<DataMember(Order=10)>]
member val ProblematicBookings:ThreeDayCounts = null with get,set
[<DataMember(Order=20)>]
member val AirlineTicketing:ThreeDayCounts = null with get,set
[<DataMember(Order=30)>]
member val UnticketedBookingsByTau:ThreeDayCounts = null with get,set
[<DataMember(Order=34)>]
member val OutstandingBookingActions:ThreeDayCounts = null with get,set
[<DataMember(Order=40)>]
member val MonthlyActivity:ResizeArray<MonthlyActivityBreakdown> = null with get,set
[<DataMember(Order=50)>]
member val MostActiveUsers:ResizeArray<UserActivity> = null with get,set
[<DataMember(Order=60)>]
member val TopConsultants:ResizeArray<ConsultantPerformance> = null with get,set
[<DataMember(Order=70)>]
member val TopReports:ResizeArray<ReportPerformance> = null with get,set
[<DataMember(Order=80)>]
member val ActiveBookingsAirConversion:BookingsAirConversion = null with get,set
[<DataMember(Order=90)>]
member val PassengerElements:ResizeArray<PassengerContactElements> = null with get,set
[<DataMember(Order=90)>]
member val ReportUsageSummary:ResizeArray<ReportPerformance> = null with get,set
[<DataMember(Order=200)>]
member val MonthlyActivityFormatted:String = null with get,set
[<DataMember(Order=210)>]
member val PassengerElementsFormatted:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type DashboardStatsByOptionsResponseReport() =
inherit Report<DashboardStatsByOptionsItemResponse, DashboardStats>()
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with get,set
///<summary>
///Number of records to return (PageSize)
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
member val Limit:String = null with get,set
///<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")>]
member val TotalRecords:Int32 = new Int32() with get,set
///<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")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type DashboardStatsByOptionsItemResponse() =
inherit ItemResponse<DashboardStats, DashboardStatsByOptionsResponseReport>()
[<Flags>]
type DashboardOptions =
| ProblematicBookingsCount = 1
| AirlineTicketingCount = 2
| UnticketedBookingsByTauCount = 4
| MonthlyActivity = 8
| ActiveBookingsAirConversion = 16
| PassengerContacts = 32
| TopConsultants = 64
| MostActiveUsers = 128
| TopReports = 256
| ReportUsageSummary = 512
| OutstandingBookingActionsCount = 1024
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type DashboardStatsByOptions() =
inherit PagingMetadata()
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
///<summary>
///Top reports
///</summary>
[<DataMember>]
member val ReportsTop:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Reports in days span
///</summary>
[<DataMember>]
member val ReportsDaysSpan:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Top most active users
///</summary>
[<DataMember>]
member val MostActiveUsersTop:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Most active users in days span
///</summary>
[<DataMember>]
member val MostActiveUsersDaysSpan:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Top consultants last days span
///</summary>
[<DataMember>]
member val TopConsultantsLastDaysSpan:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Options
///</summary>
[<DataMember>]
member val Options:DashboardOptions = new DashboardOptions() with get,set
F# 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>