Agentivity API

DashboardStatsByOptions

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

**DashboardStatsByOptions** Parameters:
Name	Parameter	Data Type	Required	Description
UserName	query	string	Yes	UserName in form of an email address
ReportsTop	query	integer	No	Top reports
ReportsDaysSpan	query	integer	No	Reports in days span
MostActiveUsersTop	query	integer	No	Top most active users
MostActiveUsersDaysSpan	query	integer	No	Most active users in days span
TopConsultantsLastDaysSpan	query	integer	No	Top consultants last days span
Options	query	integer	No	Options

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**DashboardOptions** Enum:
Name	Value
ProblematicBookingsCount	1
AirlineTicketingCount	2
UnticketedBookingsByTauCount	4
MonthlyActivity	8
ActiveBookingsAirConversion	16
PassengerContacts	32
TopConsultants	64
MostActiveUsers	128
TopReports	256
ReportUsageSummary	512
OutstandingBookingActionsCount	1024

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**DashboardStats** Parameters:
Name	Parameter	Data Type	Required
ProblematicBookings	form	ThreeDayCounts	No
AirlineTicketing	form	ThreeDayCounts	No
UnticketedBookingsByTau	form	ThreeDayCounts	No
OutstandingBookingActions	form	ThreeDayCounts	No
MonthlyActivity	form	List<MonthlyActivityBreakdown>	No
MostActiveUsers	form	List<UserActivity>	No
TopConsultants	form	List<ConsultantPerformance>	No
TopReports	form	List<ReportPerformance>	No
ActiveBookingsAirConversion	form	BookingsAirConversion	No
PassengerElements	form	List<PassengerContactElements>	No
ReportUsageSummary	form	List<ReportPerformance>	No
MonthlyActivityFormatted	form	string	No
PassengerElementsFormatted	form	string	No

**ThreeDayCounts** Parameters:
Name	Parameter	Data Type	Required
DayPlusZeroTtl	form	int	No
DayPlusOneTtl	form	int	No
DayPlusTwoTtl	form	int	No

**MonthlyActivityBreakdown** Parameters:
Name	Parameter	Data Type	Required
ReportDate	form	string	No
MonthlyEvents	form	int	No
C	form	int	No
C_Percentage	form	float	No
I	form	int	No
I_Percentage	form	float	No
T	form	int	No
T_Percentage	form	float	No
X	form	int	No
X_Percentage	form	float	No

**UserActivity** Parameters:
Name	Parameter	Data Type	Required
UserName	form	string	No
FirstName	form	string	No
LastName	form	string	No
UserID	form	int	No
UserFrequency	form	string	No
ActivityMeasure	form	float	No

**ConsultantPerformance** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Total	form	int	No

**ReportPerformance** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
UrlSlug	form	string	No
Total	form	int	No

**BookingsAirConversion** Parameters:
Name	Parameter	Data Type	Required	Description
TotalTicketed	form	int	No
TotalUnticketed	form	int	No

**PassengerContactElements** Parameters:
Name	Parameter	Data Type	Required
DateYear	form	int	No
DateMonth	form	int	No
WithMobilePercent	form	float	No
WithEmailPercent	form	float	No
TotalWithMobile	form	int	No
TotalWithEmail	form	int	No
TotalCreated	form	int	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	No

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

HTTP + 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>