| GET | /DashboardStats |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
@DataContract(Namespace="schemas.agentivity.com/types")
public static class DashboardStatsByOptions extends PagingMetadata
{
/**
* UserName in form of an email address
*/
@DataMember
public String UserName = null;
/**
* Top reports
*/
@DataMember
public Integer ReportsTop = null;
/**
* Reports in days span
*/
@DataMember
public Integer ReportsDaysSpan = null;
/**
* Top most active users
*/
@DataMember
public Integer MostActiveUsersTop = null;
/**
* Most active users in days span
*/
@DataMember
public Integer MostActiveUsersDaysSpan = null;
/**
* Top consultants last days span
*/
@DataMember
public Integer TopConsultantsLastDaysSpan = null;
/**
* Options
*/
@DataMember
public DashboardOptions Options = null;
public String getUserName() { return UserName; }
public DashboardStatsByOptions setUserName(String value) { this.UserName = value; return this; }
public Integer getReportsTop() { return ReportsTop; }
public DashboardStatsByOptions setReportsTop(Integer value) { this.ReportsTop = value; return this; }
public Integer getReportsDaysSpan() { return ReportsDaysSpan; }
public DashboardStatsByOptions setReportsDaysSpan(Integer value) { this.ReportsDaysSpan = value; return this; }
public Integer getMostActiveUsersTop() { return MostActiveUsersTop; }
public DashboardStatsByOptions setMostActiveUsersTop(Integer value) { this.MostActiveUsersTop = value; return this; }
public Integer getMostActiveUsersDaysSpan() { return MostActiveUsersDaysSpan; }
public DashboardStatsByOptions setMostActiveUsersDaysSpan(Integer value) { this.MostActiveUsersDaysSpan = value; return this; }
public Integer getTopConsultantsLastDaysSpan() { return TopConsultantsLastDaysSpan; }
public DashboardStatsByOptions setTopConsultantsLastDaysSpan(Integer value) { this.TopConsultantsLastDaysSpan = value; return this; }
public DashboardOptions getOptions() { return Options; }
public DashboardStatsByOptions setOptions(DashboardOptions value) { this.Options = value; return this; }
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
public static class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
public String Offset = null;
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
public String Limit = 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")
public Integer TotalRecords = 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")
public Integer ResponseRecords = null;
public String getOffset() { return Offset; }
public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
public String getLimit() { return Limit; }
public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
public Integer getTotalRecords() { return TotalRecords; }
public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
public Integer getResponseRecords() { return ResponseRecords; }
public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
}
@Flags()
public static enum DashboardOptions
{
@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);
private final int value;
DashboardOptions(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class DashboardStatsByOptionsItemResponse extends ItemResponse<DashboardStats, DashboardStatsByOptionsResponseReport>
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
public static class ItemResponse<TItem, TReport>
{
@DataMember(Order=1)
public ResponseMetadata ResponseMetadata = null;
@DataMember(Order=2, EmitDefaultValue=false)
public TReport ResponseReport = null;
@DataMember(Order=3, EmitDefaultValue=false)
public AgentivityError ResponseError = null;
public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
public TReport getResponseReport() { return ResponseReport; }
public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
public AgentivityError getResponseError() { return ResponseError; }
public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class ResponseMetadata
{
@DataMember(Order=0)
public Boolean Success = null;
@DataMember(Order=1)
public Boolean HasCache = null;
@DataMember(Order=2)
public Boolean HasPaging = null;
@DataMember(Order=3, EmitDefaultValue=false)
public CacheMetadata CacheMetadata = null;
@DataMember(Order=4, EmitDefaultValue=false)
public PagingMetadata PagingMetadata = null;
public Boolean isSuccess() { return Success; }
public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
public Boolean isHasCache() { return HasCache; }
public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
public Boolean isHasPaging() { return HasPaging; }
public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
public CacheMetadata getCacheMetadata() { return CacheMetadata; }
public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
public PagingMetadata getPagingMetadata() { return PagingMetadata; }
public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
public static class CacheMetadata
{
@DataMember(Order=1)
public Date CachedAt = null;
@DataMember(Order=2)
public Date CacheExpiresAt = null;
@DataMember(Order=0)
public Boolean IsFromCache = null;
public Date getCachedAt() { return CachedAt; }
public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
public Date getCacheExpiresAt() { return CacheExpiresAt; }
public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
public Boolean getIsFromCache() { return IsFromCache; }
public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
public static class AgentivityError
{
@DataMember
public String ErrorCode = null;
@DataMember
public String Message = null;
@DataMember
public String StatusCode = null;
@DataMember
public String VerboseMessage = null;
public String getErrorCode() { return ErrorCode; }
public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getMessage() { return Message; }
public AgentivityError setMessage(String value) { this.Message = value; return this; }
public String getStatusCode() { return StatusCode; }
public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
public String getVerboseMessage() { return VerboseMessage; }
public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
}
@DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
public static class DashboardStats
{
@DataMember(Order=10)
public ThreeDayCounts ProblematicBookings = null;
@DataMember(Order=20)
public ThreeDayCounts AirlineTicketing = null;
@DataMember(Order=30)
public ThreeDayCounts UnticketedBookingsByTau = null;
@DataMember(Order=34)
public ThreeDayCounts OutstandingBookingActions = null;
@DataMember(Order=40)
public ArrayList<MonthlyActivityBreakdown> MonthlyActivity = null;
@DataMember(Order=50)
public ArrayList<UserActivity> MostActiveUsers = null;
@DataMember(Order=60)
public ArrayList<ConsultantPerformance> TopConsultants = null;
@DataMember(Order=70)
public ArrayList<ReportPerformance> TopReports = null;
@DataMember(Order=80)
public BookingsAirConversion ActiveBookingsAirConversion = null;
@DataMember(Order=90)
public ArrayList<PassengerContactElements> PassengerElements = null;
@DataMember(Order=90)
public ArrayList<ReportPerformance> ReportUsageSummary = null;
@DataMember(Order=200)
public String MonthlyActivityFormatted = null;
@DataMember(Order=210)
public String PassengerElementsFormatted = null;
public ThreeDayCounts getProblematicBookings() { return ProblematicBookings; }
public DashboardStats setProblematicBookings(ThreeDayCounts value) { this.ProblematicBookings = value; return this; }
public ThreeDayCounts getAirlineTicketing() { return AirlineTicketing; }
public DashboardStats setAirlineTicketing(ThreeDayCounts value) { this.AirlineTicketing = value; return this; }
public ThreeDayCounts getUnticketedBookingsByTau() { return UnticketedBookingsByTau; }
public DashboardStats setUnticketedBookingsByTau(ThreeDayCounts value) { this.UnticketedBookingsByTau = value; return this; }
public ThreeDayCounts getOutstandingBookingActions() { return OutstandingBookingActions; }
public DashboardStats setOutstandingBookingActions(ThreeDayCounts value) { this.OutstandingBookingActions = value; return this; }
public ArrayList<MonthlyActivityBreakdown> getMonthlyActivity() { return MonthlyActivity; }
public DashboardStats setMonthlyActivity(ArrayList<MonthlyActivityBreakdown> value) { this.MonthlyActivity = value; return this; }
public ArrayList<UserActivity> getMostActiveUsers() { return MostActiveUsers; }
public DashboardStats setMostActiveUsers(ArrayList<UserActivity> value) { this.MostActiveUsers = value; return this; }
public ArrayList<ConsultantPerformance> getTopConsultants() { return TopConsultants; }
public DashboardStats setTopConsultants(ArrayList<ConsultantPerformance> value) { this.TopConsultants = value; return this; }
public ArrayList<ReportPerformance> getTopReports() { return TopReports; }
public DashboardStats setTopReports(ArrayList<ReportPerformance> value) { this.TopReports = value; return this; }
public BookingsAirConversion getActiveBookingsAirConversion() { return ActiveBookingsAirConversion; }
public DashboardStats setActiveBookingsAirConversion(BookingsAirConversion value) { this.ActiveBookingsAirConversion = value; return this; }
public ArrayList<PassengerContactElements> getPassengerElements() { return PassengerElements; }
public DashboardStats setPassengerElements(ArrayList<PassengerContactElements> value) { this.PassengerElements = value; return this; }
public ArrayList<ReportPerformance> getReportUsageSummary() { return ReportUsageSummary; }
public DashboardStats setReportUsageSummary(ArrayList<ReportPerformance> value) { this.ReportUsageSummary = value; return this; }
public String getMonthlyActivityFormatted() { return MonthlyActivityFormatted; }
public DashboardStats setMonthlyActivityFormatted(String value) { this.MonthlyActivityFormatted = value; return this; }
public String getPassengerElementsFormatted() { return PassengerElementsFormatted; }
public DashboardStats setPassengerElementsFormatted(String value) { this.PassengerElementsFormatted = value; return this; }
}
@DataContract(Name="ThreeDayCounts", Namespace="schemas.agentivity.com/types")
public static class ThreeDayCounts
{
@DataMember(Order=10)
public Integer DayPlusZeroTtl = null;
@DataMember(Order=20)
public Integer DayPlusOneTtl = null;
@DataMember(Order=30)
public Integer DayPlusTwoTtl = null;
public Integer getDayPlusZeroTtl() { return DayPlusZeroTtl; }
public ThreeDayCounts setDayPlusZeroTtl(Integer value) { this.DayPlusZeroTtl = value; return this; }
public Integer getDayPlusOneTtl() { return DayPlusOneTtl; }
public ThreeDayCounts setDayPlusOneTtl(Integer value) { this.DayPlusOneTtl = value; return this; }
public Integer getDayPlusTwoTtl() { return DayPlusTwoTtl; }
public ThreeDayCounts setDayPlusTwoTtl(Integer value) { this.DayPlusTwoTtl = value; return this; }
}
@DataContract(Name="MonthlyActivityBreakdown", Namespace="schemas.agentivity.com/types")
public static class MonthlyActivityBreakdown
{
@DataMember(Order=10)
public String ReportDate = null;
@DataMember(Order=20)
public Integer MonthlyEvents = null;
@DataMember(Order=30)
public Integer C = null;
@DataMember(Order=40)
public Float C_Percentage = null;
@DataMember(Order=50)
public Integer I = null;
@DataMember(Order=60)
public Float I_Percentage = null;
@DataMember(Order=70)
public Integer T = null;
@DataMember(Order=80)
public Float T_Percentage = null;
@DataMember(Order=90)
public Integer X = null;
@DataMember(Order=100)
public Float X_Percentage = null;
public String getReportDate() { return ReportDate; }
public MonthlyActivityBreakdown setReportDate(String value) { this.ReportDate = value; return this; }
public Integer getMonthlyEvents() { return MonthlyEvents; }
public MonthlyActivityBreakdown setMonthlyEvents(Integer value) { this.MonthlyEvents = value; return this; }
public Integer getC() { return C; }
public MonthlyActivityBreakdown setC(Integer value) { this.C = value; return this; }
public Float getCPercentage() { return C_Percentage; }
public MonthlyActivityBreakdown setCPercentage(Float value) { this.C_Percentage = value; return this; }
public Integer getI() { return I; }
public MonthlyActivityBreakdown setI(Integer value) { this.I = value; return this; }
public Float getIPercentage() { return I_Percentage; }
public MonthlyActivityBreakdown setIPercentage(Float value) { this.I_Percentage = value; return this; }
public Integer getT() { return T; }
public MonthlyActivityBreakdown setT(Integer value) { this.T = value; return this; }
public Float getTPercentage() { return T_Percentage; }
public MonthlyActivityBreakdown setTPercentage(Float value) { this.T_Percentage = value; return this; }
public Integer getX() { return X; }
public MonthlyActivityBreakdown setX(Integer value) { this.X = value; return this; }
public Float getXPercentage() { return X_Percentage; }
public MonthlyActivityBreakdown setXPercentage(Float value) { this.X_Percentage = value; return this; }
}
@DataContract(Name="UserActivity", Namespace="schemas.agentivity.com/types")
public static class UserActivity
{
@DataMember(Order=10)
public String UserName = null;
@DataMember(Order=20)
public String FirstName = null;
@DataMember(Order=30)
public String LastName = null;
@DataMember(Order=40)
public Integer UserID = null;
@DataMember(Order=50)
public String UserFrequency = null;
@DataMember(Order=60)
public Float ActivityMeasure = null;
public String getUserName() { return UserName; }
public UserActivity setUserName(String value) { this.UserName = value; return this; }
public String getFirstName() { return FirstName; }
public UserActivity setFirstName(String value) { this.FirstName = value; return this; }
public String getLastName() { return LastName; }
public UserActivity setLastName(String value) { this.LastName = value; return this; }
public Integer getUserID() { return UserID; }
public UserActivity setUserID(Integer value) { this.UserID = value; return this; }
public String getUserFrequency() { return UserFrequency; }
public UserActivity setUserFrequency(String value) { this.UserFrequency = value; return this; }
public Float getActivityMeasure() { return ActivityMeasure; }
public UserActivity setActivityMeasure(Float value) { this.ActivityMeasure = value; return this; }
}
@DataContract(Name="ConsultantPerformance", Namespace="schemas.agentivity.com/types")
public static class ConsultantPerformance
{
@DataMember(Order=10)
public String Name = null;
@DataMember(Order=20)
public Integer Total = null;
public String getName() { return Name; }
public ConsultantPerformance setName(String value) { this.Name = value; return this; }
public Integer getTotal() { return Total; }
public ConsultantPerformance setTotal(Integer value) { this.Total = value; return this; }
}
@DataContract(Name="ReportPerformance", Namespace="schemas.agentivity.com/types")
public static class ReportPerformance
{
@DataMember(Order=10)
public String Name = null;
@DataMember(Order=20)
public String UrlSlug = null;
@DataMember(Order=30)
public Integer Total = null;
public String getName() { return Name; }
public ReportPerformance setName(String value) { this.Name = value; return this; }
public String getUrlSlug() { return UrlSlug; }
public ReportPerformance setUrlSlug(String value) { this.UrlSlug = value; return this; }
public Integer getTotal() { return Total; }
public ReportPerformance setTotal(Integer value) { this.Total = value; return this; }
}
@DataContract(Name="BookingsAirConversion", Namespace="schemas.agentivity.com/types")
public static class BookingsAirConversion
{
@DataMember(Order=10)
public Integer TotalTicketed = null;
@DataMember(Order=20)
public Integer TotalUnticketed = null;
public Integer getTotalTicketed() { return TotalTicketed; }
public BookingsAirConversion setTotalTicketed(Integer value) { this.TotalTicketed = value; return this; }
public Integer getTotalUnticketed() { return TotalUnticketed; }
public BookingsAirConversion setTotalUnticketed(Integer value) { this.TotalUnticketed = value; return this; }
}
@DataContract(Name="PassengerContactElements", Namespace="schemas.agentivity.com/types")
public static class PassengerContactElements
{
@DataMember(Order=20)
public Integer DateYear = null;
@DataMember(Order=20)
public Integer DateMonth = null;
@DataMember(Order=30)
public Float WithMobilePercent = null;
@DataMember(Order=40)
public Float WithEmailPercent = null;
@DataMember(Order=50)
public Integer TotalWithMobile = null;
@DataMember(Order=60)
public Integer TotalWithEmail = null;
@DataMember(Order=70)
public Integer TotalCreated = null;
public Integer getDateYear() { return DateYear; }
public PassengerContactElements setDateYear(Integer value) { this.DateYear = value; return this; }
public Integer getDateMonth() { return DateMonth; }
public PassengerContactElements setDateMonth(Integer value) { this.DateMonth = value; return this; }
public Float getWithMobilePercent() { return WithMobilePercent; }
public PassengerContactElements setWithMobilePercent(Float value) { this.WithMobilePercent = value; return this; }
public Float getWithEmailPercent() { return WithEmailPercent; }
public PassengerContactElements setWithEmailPercent(Float value) { this.WithEmailPercent = value; return this; }
public Integer getTotalWithMobile() { return TotalWithMobile; }
public PassengerContactElements setTotalWithMobile(Integer value) { this.TotalWithMobile = value; return this; }
public Integer getTotalWithEmail() { return TotalWithEmail; }
public PassengerContactElements setTotalWithEmail(Integer value) { this.TotalWithEmail = value; return this; }
public Integer getTotalCreated() { return TotalCreated; }
public PassengerContactElements setTotalCreated(Integer value) { this.TotalCreated = value; return this; }
}
@DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
public static class DashboardStatsByOptionsResponseReport extends Report<DashboardStatsByOptionsItemResponse, DashboardStats>
{
}
@DataContract(Namespace="schemas.agentivity.com/types")
public static class Report<TItemResponse, TItem>
{
@DataMember(Order=1, EmitDefaultValue=false)
public TItem Item = null;
public TItem getItem() { return Item; }
public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
}
}
Java DashboardStatsByOptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"ProblematicBookings":{"DayPlusZeroTtl":0,"DayPlusOneTtl":0,"DayPlusTwoTtl":0},"AirlineTicketing":{"DayPlusZeroTtl":0,"DayPlusOneTtl":0,"DayPlusTwoTtl":0},"UnticketedBookingsByTau":{"DayPlusZeroTtl":0,"DayPlusOneTtl":0,"DayPlusTwoTtl":0},"OutstandingBookingActions":{"DayPlusZeroTtl":0,"DayPlusOneTtl":0,"DayPlusTwoTtl":0},"MonthlyActivity":[{"ReportDate":"String","MonthlyEvents":0,"C":0,"C_Percentage":0,"I":0,"I_Percentage":0,"T":0,"T_Percentage":0,"X":0,"X_Percentage":0}],"MostActiveUsers":[{"UserName":"String","FirstName":"String","LastName":"String","UserID":0,"UserFrequency":"String","ActivityMeasure":0}],"TopConsultants":[{"Name":"String","Total":0}],"TopReports":[{"Name":"String","UrlSlug":"String","Total":0}],"ActiveBookingsAirConversion":{"TotalTicketed":0,"TotalUnticketed":0},"PassengerElements":[{"DateYear":0,"DateMonth":0,"WithMobilePercent":0,"WithEmailPercent":0,"TotalWithMobile":0,"TotalWithEmail":0,"TotalCreated":0}],"ReportUsageSummary":[{"Name":"String","UrlSlug":"String","Total":0}],"MonthlyActivityFormatted":"String","PassengerElementsFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}