GET | /DashboardStats |
---|
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 |
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) |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseMetadata | form | ResponseMetadata | No | |
ResponseReport | form | TReport | No | |
ResponseError | form | AgentivityError | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | |
HasCache | form | bool | No | |
HasPaging | form | bool | No | |
CacheMetadata | form | CacheMetadata | No | |
PagingMetadata | form | PagingMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CachedAt | form | DateTime | No | |
CacheExpiresAt | form | DateTime | No | |
IsFromCache | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
Message | form | string | No | |
StatusCode | form | string | No | |
VerboseMessage | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayPlusZeroTtl | form | int | No | |
DayPlusOneTtl | form | int | No | |
DayPlusTwoTtl | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
UserID | form | int | No | |
UserFrequency | form | string | No | |
ActivityMeasure | form | float | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Total | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
UrlSlug | form | string | No | |
Total | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalTicketed | form | int | No | |
TotalUnticketed | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
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 .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"}}