Custom name to identify a report
User who is trying to generate a report. It is for record purposes.
Report templates can be scheduled with frequency: [DAILY, MONTHLY, SPECIFIC_DAY_OF_WEEK, SPECIFIC_DAY_OF_MONTH]
Monthly scheduled reports will run on 1st of every month.
The day of the week when user wants 'SPECIFIC_DAY_OF_WEEK' selected frequency to trigger.
Duration for which user wants to generate a report. Duration enumeration includes: [
LAST_1_DAY, LAST_3_DAY, LAST_7_DAY, MONTHTODATE, LASTMONTH, CUSTOM]
If CUSTOM duration is selected then user needs to provide StartDate and EndDate elements.
The report status value
The day of the month when user wants 'SPECIFIC_DAY_OF_MONTH' selected frequency to trigger.
It can have dates range 01 - 31
Report Preview Record Count
API supports filtering on built-in fields. ColumnName enumeration includes: [
RATE_PLAN, POOL_NAME, SERVICE_NAME, TRAFFIC_POLICY, TRAFFIC_TYPE, REPORT_GROUP, STATUS, POOL_NAME_AND_STATUS,
REPORT_GROUP_AND_STATUS, RATE_PLAN_AND_STATUS, MIN, SCLID, MSISDN, MDN, MEID, ESN, ICCID, IMSI, PENDING_RATE_PLAN,
PENDING_POOL_NAME, EFFECTIVE_DATE]
Any value for the selected ColumnName element should be provided here. Depending on Operator this value will be included/excluded in the generated report.
Sort Order Enumeration
This identifies which report user wants to generate. The report type enumeration includes: [DEVICE_DETAIL,TRAFFIC_DETAIL,TRAFFIC_COST_SUMMARY,DEVICE_DAILY_TRAFFIC_USAGE,DEVICE_STATUS_ACTIVITY
,DEVICE_TRAFFIC_USAGE,DEVICE_SUMMARY,TRAFFIC_SUMMARY_TREND,COST_SUMMARY_TREND,DEVICE_SUMMARY_TREND]
The report filter operators to be used for filtering data. Operator is an enumeration which includes: [
EQUALS, NOT_EQUALS, IN, LIKE, BETWEEN].
Starting point of pulling a report.
End point of pulling a report.
Enumeration of mobile or fixed
Authentication Key usually 20 digits with additional 6 digits of check sum
Custom Field Type
Generic date type
device Status
AccountId
Flag indicating whether it is a online report
Flag indicating whether it is a subaccounts
if true will return report for all the accounts in the hierarchy
if true will return report for all devices ignoring any device filters
if true for schedule report
if true will provide a preview report with 100 records. Should be true for ONLINE and false for SCHEDULE reports.
if true will return report should be visible to sub-account else false
Provides information if report preview is complete
Email of user who is trying to generate a report. It is for record purposes.
ReportGroup that a device belongs to.
It specifies product for which user wants to generate report. ANY value can be provided if user wishes not to specify any specific product.
Product enumeration includes: [CDMA, CDMACC, GLOBALSIM, COVERAGESIM, AERCLOUD, ANY]
TrafficPolicy block/unblock enumeration
Mobile Identification Number Type
Mobile Station Integrated Services Digital Network
Type
MSID
Electronic Serial Number Type
Universal Integrated Circuit Card Identifier Type
Pool Name
Rate Plan
Unique transaction id
Mobile Equipment Identifier Type
Message Type
International Mobile Subscriber Identity String Type
TimeTaken
Code Type
Unique Api Key
Is true when processing started
Is true when processing completed