Get Overall Traffic Report
GET/overall-traffic-reports
Returns Overall Traffic Report in JSON format.
Additional Rules:
- If no embed fields are provided, the default embed fields will be used.
- msgDt is only avaliable for hour grain.
- If groupBy is provided all of fields must also be in the embed fields, if not API will add them.
- If groupBy is provided and sellAmount is in the embed parameters, sellCurrency or sellCurrencyCode should be in the groupBy fields. If not API will add them.
- If groupBy is provided and buyAmount is in the embed parameters, buyCurrency or buyCurrencyCode should be in the groupBy fields. If not API will add them.
- If groupBy is provided and sellAmountInCurr, buyAmountInCurr, profit or intCost is in the embed parameters, currency or currencyCode should be in the groupBy fields. If not API will add them.
Aggergated Fields (this is just informative, they are aggregated if groupBy is provided):
- sellAmount
- inSmsCnt
- inBilledSmsCnt
- buyAmount
- outSmsCnt
- outBilledSmsCnt
- sellAmountInCurr
- buyAmountInCurr
- intCost
- intRequestCnt
- profit
- stProcessingCnt
- stSentCnt
- stRejectNackCnt
- stRejectRulesCnt
- stErrorCnt
- stUnknownCnt
Sortable Fields:
- customerId
- customerBriefName
- billingAccountId
- billingAccountName
- supplierId
- supplierBriefName
- gateBillingAccountId
- gateBillingAccountName
- accountId
- accountName
- gateId
- gateName
- countryName
- countryCode2
- operatorId
- operatorName
- currencyCode
- sellCurrencyCode
- buyCurrencyCode
- mcc
- mnc
- msgDate
- accountDim
- billingAccountDim
- customerDim
- countryId
- operatorDim
- gateDim
- billingGateDim
- sellPrice
- sellAmount
- sellCurrency
- inSmsCnt
- inBilledSmsCnt
- buyPrice
- buyAmount
- buyCurrency
- outSmsCnt
- outBilledSmsCnt
- currency
- sellAmountInCurr
- buyAmountInCurr
- intCost
- intRequestCnt
- profit
- stProcessingCnt
- stSentCnt
- stRejectNackCnt
- stRejectRulesCnt
- stErrorCnt
- stUnknownCnt
- msgDt
Embeddable Fields:
- msgDate
- accountDim
- billingAccountDim
- customerDim
- countryId
- operatorDim
- gateDim
- billingGateDim
- sellPrice
- sellCurrency
- buyPrice
- buyCurrency
- currency
- customerId
- billingAccountId
- billingAccountName
- supplierId
- gateBillingAccountId
- gateBillingAccountName
- accountId
- accountName
- gateId
- gateName
- countryName
- countryCode2
- operatorId
- operatorName
- currencyCode
- sellCurrencyCode
- buyCurrencyCode
- mcc
- mnc
- customerBriefName
- supplierBriefName
- isMobile
- msgDt
- sellAmount
- inSmsCnt
- inBilledSmsCnt
- buyAmount
- outSmsCnt
- outBilledSmsCnt
- sellAmountInCurr
- buyAmountInCurr
- intCost
- intRequestCnt
- profit
- stProcessingCnt
- stSentCnt
- stRejectNackCnt
- stRejectRulesCnt
- stErrorCnt
- stUnknownCnt
- customerAccManagerId
- customerAccManagerName
- customerAccManagerEmail
- supplierAccManagerId
- supplierAccManagerName
- supplierAccManagerEmail
GroupBy Fields:
- msgDate
- accountDim
- billingAccountDim
- customerDim
- countryId
- operatorDim
- gateDim
- billingGateDim
- sellPrice
- sellCurrency
- buyPrice
- buyCurrency
- currency
- customerId
- billingAccountId
- billingAccountName
- supplierId
- gateBillingAccountId
- gateBillingAccountName
- accountId
- accountName
- gateId
- gateName
- countryName
- countryCode2
- operatorId
- operatorName
- currencyCode
- sellCurrencyCode
- buyCurrencyCode
- mcc
- mnc
- customerBriefName
- supplierBriefName
- isMobile
Filter Fields:
- customerId
- customerBriefName
- billingAccountId
- billingAccountName
- supplierId
- supplierBriefName
- gateBillingAccountId
- gateBillingAccountName
- accountId
- accountName
- gateId
- gateName
- countryName
- countryCode2
- operatorId
- operatorName
- currencyCode
- sellCurrencyCode
- buyCurrencyCode
- mcc
- mnc
- msgDate
- accountDim
- billingAccountDim
- customerDim
- countryId
- operatorDim
- gateDim
- billingGateDim
- sellPrice
- sellAmount
- sellCurrency
- inSmsCnt
- inBilledSmsCnt
- buyPrice
- buyAmount
- buyCurrency
- outSmsCnt
- outBilledSmsCnt
- currency
- sellAmountInCurr
- buyAmountInCurr
- intCost
- intRequestCnt
- profit
- stProcessingCnt
- stSentCnt
- stRejectNackCnt
- stRejectRulesCnt
- stErrorCnt
- stUnknownCnt
- msgDt
Searchable Fields:
- billingAccountName
- gateBillingAccountName
- accountName
- gateName
- countryName
Pagination is not allowed for this endpoint.
Errors:
- START_DT_MISSING - Start datetime is missing
- END_DT_MISSING - End datetime is missing
- START_DT_BAD_FORMAT - Start datetime is in bad format
- END_DT_BAD_FORMAT - End datetime is in bad format
- UNSUPPORTED_GRAIN - Requested grain is not supported
- START_DATE_AFTER_END_DATE - Start date is after end date
- TIME_SPAN_GREATER_THAN_365_DAYS - Time span is greater than 365 days
- BULK_SETTINGS_NOT_FOUND - Bulk settings not found
- MAX_EXECUTION_TIME_EXCEEDED - Max execution time exceeded
Privilege:
- bulk-traffic-report-view
- bulk-traffic-report-own.view
Request
Responses
- 200
- 400
Overall Traffic Report
Error response