| GET | /DashboardStats |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel;
namespace AgentivityAPI.ServiceModel
{
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class ItemResponse<TItem, TReport>
{
[DataMember(Order=1)]
public virtual ResponseMetadata ResponseMetadata { get; set; }
[DataMember(Order=2, EmitDefaultValue=false)]
public virtual TReport ResponseReport { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual AgentivityError ResponseError { get; set; }
}
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class Report<TItemResponse, TItem>
{
[DataMember(Order=1, EmitDefaultValue=false)]
public virtual TItem Item { get; set; }
}
}
namespace AgentivityAPI.ServiceModel.Types
{
[DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
public partial class AgentivityError
{
[DataMember]
public virtual string ErrorCode { get; set; }
[DataMember]
public virtual string Message { get; set; }
[DataMember]
public virtual string StatusCode { get; set; }
[DataMember]
public virtual string VerboseMessage { get; set; }
}
[DataContract(Name="BookingsAirConversion", Namespace="schemas.agentivity.com/types")]
public partial class BookingsAirConversion
{
[DataMember(Order=10)]
public virtual int TotalTicketed { get; set; }
[DataMember(Order=20)]
public virtual int TotalUnticketed { get; set; }
}
[DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
public partial class CacheMetadata
{
[DataMember(Order=1)]
public virtual DateTime CachedAt { get; set; }
[DataMember(Order=2)]
public virtual DateTime CacheExpiresAt { get; set; }
[DataMember(Order=0)]
public virtual bool IsFromCache { get; set; }
}
[DataContract(Name="ConsultantPerformance", Namespace="schemas.agentivity.com/types")]
public partial class ConsultantPerformance
{
[DataMember(Order=10)]
public virtual string Name { get; set; }
[DataMember(Order=20)]
public virtual int Total { get; set; }
}
[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,
}
[DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")]
public partial class DashboardStats
{
[DataMember(Order=10)]
public virtual ThreeDayCounts ProblematicBookings { get; set; }
[DataMember(Order=20)]
public virtual ThreeDayCounts AirlineTicketing { get; set; }
[DataMember(Order=30)]
public virtual ThreeDayCounts UnticketedBookingsByTau { get; set; }
[DataMember(Order=34)]
public virtual ThreeDayCounts OutstandingBookingActions { get; set; }
[DataMember(Order=40)]
public virtual List<MonthlyActivityBreakdown> MonthlyActivity { get; set; }
[DataMember(Order=50)]
public virtual List<UserActivity> MostActiveUsers { get; set; }
[DataMember(Order=60)]
public virtual List<ConsultantPerformance> TopConsultants { get; set; }
[DataMember(Order=70)]
public virtual List<ReportPerformance> TopReports { get; set; }
[DataMember(Order=80)]
public virtual BookingsAirConversion ActiveBookingsAirConversion { get; set; }
[DataMember(Order=90)]
public virtual List<PassengerContactElements> PassengerElements { get; set; }
[DataMember(Order=90)]
public virtual List<ReportPerformance> ReportUsageSummary { get; set; }
[DataMember(Order=200)]
public virtual string MonthlyActivityFormatted { get; set; }
[DataMember(Order=210)]
public virtual string PassengerElementsFormatted { get; set; }
}
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class DashboardStatsByOptions
: PagingMetadata
{
///<summary>
///UserName in form of an email address
///</summary>
[DataMember]
public virtual string UserName { get; set; }
///<summary>
///Top reports
///</summary>
[DataMember]
public virtual int? ReportsTop { get; set; }
///<summary>
///Reports in days span
///</summary>
[DataMember]
public virtual int? ReportsDaysSpan { get; set; }
///<summary>
///Top most active users
///</summary>
[DataMember]
public virtual int? MostActiveUsersTop { get; set; }
///<summary>
///Most active users in days span
///</summary>
[DataMember]
public virtual int? MostActiveUsersDaysSpan { get; set; }
///<summary>
///Top consultants last days span
///</summary>
[DataMember]
public virtual int? TopConsultantsLastDaysSpan { get; set; }
///<summary>
///Options
///</summary>
[DataMember]
public virtual DashboardOptions Options { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class DashboardStatsByOptionsItemResponse
: ItemResponse<DashboardStats, DashboardStatsByOptionsResponseReport>
{
}
[DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")]
public partial class DashboardStatsByOptionsResponseReport
: Report<DashboardStatsByOptionsItemResponse, DashboardStats>
{
}
[DataContract(Name="MonthlyActivityBreakdown", Namespace="schemas.agentivity.com/types")]
public partial class MonthlyActivityBreakdown
{
[DataMember(Order=10)]
public virtual string ReportDate { get; set; }
[DataMember(Order=20)]
public virtual int MonthlyEvents { get; set; }
[DataMember(Order=30)]
public virtual int C { get; set; }
[DataMember(Order=40)]
public virtual float C_Percentage { get; set; }
[DataMember(Order=50)]
public virtual int I { get; set; }
[DataMember(Order=60)]
public virtual float I_Percentage { get; set; }
[DataMember(Order=70)]
public virtual int T { get; set; }
[DataMember(Order=80)]
public virtual float T_Percentage { get; set; }
[DataMember(Order=90)]
public virtual int X { get; set; }
[DataMember(Order=100)]
public virtual float X_Percentage { get; set; }
}
[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 virtual string Offset { 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")]
public virtual string Limit { 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")]
public virtual int TotalRecords { 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")]
public virtual int ResponseRecords { get; set; }
}
[DataContract(Name="PassengerContactElements", Namespace="schemas.agentivity.com/types")]
public partial class PassengerContactElements
{
[DataMember(Order=20)]
public virtual int DateYear { get; set; }
[DataMember(Order=20)]
public virtual int DateMonth { get; set; }
[DataMember(Order=30)]
public virtual float WithMobilePercent { get; set; }
[DataMember(Order=40)]
public virtual float WithEmailPercent { get; set; }
[DataMember(Order=50)]
public virtual int TotalWithMobile { get; set; }
[DataMember(Order=60)]
public virtual int TotalWithEmail { get; set; }
[DataMember(Order=70)]
public virtual int TotalCreated { get; set; }
}
[DataContract(Name="ReportPerformance", Namespace="schemas.agentivity.com/types")]
public partial class ReportPerformance
{
[DataMember(Order=10)]
public virtual string Name { get; set; }
[DataMember(Order=20)]
public virtual string UrlSlug { get; set; }
[DataMember(Order=30)]
public virtual int Total { get; set; }
}
[DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
public partial class ResponseMetadata
{
[DataMember(Order=0)]
public virtual bool Success { get; set; }
[DataMember(Order=1)]
public virtual bool HasCache { get; set; }
[DataMember(Order=2)]
public virtual bool HasPaging { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual CacheMetadata CacheMetadata { get; set; }
[DataMember(Order=4, EmitDefaultValue=false)]
public virtual PagingMetadata PagingMetadata { get; set; }
}
[DataContract(Name="ThreeDayCounts", Namespace="schemas.agentivity.com/types")]
public partial class ThreeDayCounts
{
[DataMember(Order=10)]
public virtual int DayPlusZeroTtl { get; set; }
[DataMember(Order=20)]
public virtual int DayPlusOneTtl { get; set; }
[DataMember(Order=30)]
public virtual int DayPlusTwoTtl { get; set; }
}
[DataContract(Name="UserActivity", Namespace="schemas.agentivity.com/types")]
public partial class UserActivity
{
[DataMember(Order=10)]
public virtual string UserName { get; set; }
[DataMember(Order=20)]
public virtual string FirstName { get; set; }
[DataMember(Order=30)]
public virtual string LastName { get; set; }
[DataMember(Order=40)]
public virtual int UserID { get; set; }
[DataMember(Order=50)]
public virtual string UserFrequency { get; set; }
[DataMember(Order=60)]
public virtual float ActivityMeasure { get; set; }
}
}
C# 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>