Agentivity API

<back to all web services

DashboardStatsByOptions

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

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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 TotalRecords: number;

    /** @description 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 ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ThreeDayCounts", Namespace="schemas.agentivity.com/types")
export class ThreeDayCounts
{
    // @DataMember(Order=10)
    public DayPlusZeroTtl: number;

    // @DataMember(Order=20)
    public DayPlusOneTtl: number;

    // @DataMember(Order=30)
    public DayPlusTwoTtl: number;

    public constructor(init?: Partial<ThreeDayCounts>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="MonthlyActivityBreakdown", Namespace="schemas.agentivity.com/types")
export class MonthlyActivityBreakdown
{
    // @DataMember(Order=10)
    public ReportDate: string;

    // @DataMember(Order=20)
    public MonthlyEvents: number;

    // @DataMember(Order=30)
    public C: number;

    // @DataMember(Order=40)
    public C_Percentage: number;

    // @DataMember(Order=50)
    public I: number;

    // @DataMember(Order=60)
    public I_Percentage: number;

    // @DataMember(Order=70)
    public T: number;

    // @DataMember(Order=80)
    public T_Percentage: number;

    // @DataMember(Order=90)
    public X: number;

    // @DataMember(Order=100)
    public X_Percentage: number;

    public constructor(init?: Partial<MonthlyActivityBreakdown>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="UserActivity", Namespace="schemas.agentivity.com/types")
export class UserActivity
{
    // @DataMember(Order=10)
    public UserName: string;

    // @DataMember(Order=20)
    public FirstName: string;

    // @DataMember(Order=30)
    public LastName: string;

    // @DataMember(Order=40)
    public UserID: number;

    // @DataMember(Order=50)
    public UserFrequency: string;

    // @DataMember(Order=60)
    public ActivityMeasure: number;

    public constructor(init?: Partial<UserActivity>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ConsultantPerformance", Namespace="schemas.agentivity.com/types")
export class ConsultantPerformance
{
    // @DataMember(Order=10)
    public Name: string;

    // @DataMember(Order=20)
    public Total: number;

    public constructor(init?: Partial<ConsultantPerformance>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ReportPerformance", Namespace="schemas.agentivity.com/types")
export class ReportPerformance
{
    // @DataMember(Order=10)
    public Name: string;

    // @DataMember(Order=20)
    public UrlSlug: string;

    // @DataMember(Order=30)
    public Total: number;

    public constructor(init?: Partial<ReportPerformance>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="BookingsAirConversion", Namespace="schemas.agentivity.com/types")
export class BookingsAirConversion
{
    // @DataMember(Order=10)
    public TotalTicketed: number;

    // @DataMember(Order=20)
    public TotalUnticketed: number;

    public constructor(init?: Partial<BookingsAirConversion>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="PassengerContactElements", Namespace="schemas.agentivity.com/types")
export class PassengerContactElements
{
    // @DataMember(Order=20)
    public DateYear: number;

    // @DataMember(Order=20)
    public DateMonth: number;

    // @DataMember(Order=30)
    public WithMobilePercent: number;

    // @DataMember(Order=40)
    public WithEmailPercent: number;

    // @DataMember(Order=50)
    public TotalWithMobile: number;

    // @DataMember(Order=60)
    public TotalWithEmail: number;

    // @DataMember(Order=70)
    public TotalCreated: number;

    public constructor(init?: Partial<PassengerContactElements>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
export class DashboardStats
{
    // @DataMember(Order=10)
    public ProblematicBookings: ThreeDayCounts;

    // @DataMember(Order=20)
    public AirlineTicketing: ThreeDayCounts;

    // @DataMember(Order=30)
    public UnticketedBookingsByTau: ThreeDayCounts;

    // @DataMember(Order=34)
    public OutstandingBookingActions: ThreeDayCounts;

    // @DataMember(Order=40)
    public MonthlyActivity: MonthlyActivityBreakdown[];

    // @DataMember(Order=50)
    public MostActiveUsers: UserActivity[];

    // @DataMember(Order=60)
    public TopConsultants: ConsultantPerformance[];

    // @DataMember(Order=70)
    public TopReports: ReportPerformance[];

    // @DataMember(Order=80)
    public ActiveBookingsAirConversion: BookingsAirConversion;

    // @DataMember(Order=90)
    public PassengerElements: PassengerContactElements[];

    // @DataMember(Order=90)
    public ReportUsageSummary: ReportPerformance[];

    // @DataMember(Order=200)
    public MonthlyActivityFormatted: string;

    // @DataMember(Order=210)
    public PassengerElementsFormatted: string;

    public constructor(init?: Partial<DashboardStats>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="DashboardStats", Namespace="schemas.agentivity.com/types")
export class DashboardStatsByOptionsResponseReport extends Report<DashboardStatsByOptionsItemResponse, DashboardStats>
{

    public constructor(init?: Partial<DashboardStatsByOptionsResponseReport>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class ItemResponse<TItem, TReport>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: TReport;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class DashboardStatsByOptionsItemResponse extends ItemResponse<DashboardStats, DashboardStatsByOptionsResponseReport>
{

    public constructor(init?: Partial<DashboardStatsByOptionsItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export 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(Namespace="schemas.agentivity.com/types")
export class DashboardStatsByOptions extends PagingMetadata
{
    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    /** @description Top reports */
    // @DataMember
    public ReportsTop?: number;

    /** @description Reports in days span */
    // @DataMember
    public ReportsDaysSpan?: number;

    /** @description Top most active users */
    // @DataMember
    public MostActiveUsersTop?: number;

    /** @description Most active users in days span */
    // @DataMember
    public MostActiveUsersDaysSpan?: number;

    /** @description Top consultants last days span */
    // @DataMember
    public TopConsultantsLastDaysSpan?: number;

    /** @description Options */
    // @DataMember
    public Options: DashboardOptions;

    public constructor(init?: Partial<DashboardStatsByOptions>) { super(init); (Object as any).assign(this, init); }
}

TypeScript DashboardStatsByOptions DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}