Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 21

...

Screenshot: Summary Report query form

Image RemovedImage Added

Creating a New Summary Report 

...

Information block Field Description
Filters

On the Filters menu, select the required parameters for the report. To cancel any filter, click on the delete  icon next to the filter.

You can start a quick search by typing filters' names in the field at the top of a drop-down menu with filters.

Period (1)

Specify the time interval for the report and a timezone. Please note that the Period field is mandatory.

Period 2

Accessible when you enable the Compare Period option by clicking on the plus icon next to the Period. Specify the second interval for the report:

  • Previous Period
  • Previous Day
  • Previous Week
  • Previous Month
  • Previous Year
Group by

Select from the list of the following accessible options to group the data in reports:

  • Time: Year, Month, Day, Hour
  • Clients: Client Type, Client ID, Account ID, CС Series, Owner ID, Package ID
  • Events: Dst Code, Dst Code Name, Dst Country, Currency, Origin, Service, Result Code, Gateway ID, Gateway Tag
  • Extras: Time Profile, Setup Fee, Rate, Additive Rate.
Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

  • TheGroup by field is mandatory, it couldn't be empty in order to generate the report. By default, there must be at least two options: Origin and Service Name.
  • If you group by Client and his/her Timezone differs from the system Timezone, the latter will be used in the respective report.
  • When you are grouping by year, it is recommended to indicate the calendar year in the period. Same goes for other period types.


Additional Filters

The accessible additional filters are:

  • ClientsClient Tags, Client Type, Client, Account, Account Tags, Cards Serial, Package.
  • Events: Code, Code Name, Cost Total, Origin, Result Code, Gateway.
  • Extras: Owner, Total Volume, Total records, Not Zero Records, ASR Current, ACD Current, Service Name.

Client TypeSelect a client's type for the report: Client, Reseller, Calling Card or Call Shop
Client Define a client for the report
AccountEnter an account for the report
Client/Account TagsDefine a client's or account's tag
Cards Serial Indicate cards serial for the report
PackageEnter a package for the report
CodeSpecify a code of the needed destination
Code NameSpecify a code name of the desired destination
Cost Total Enter the range of total call cost
OriginIndicate an origin - origination or termination of the event
Result CodeDefine a result code as a filtering parameter
GatewaySpecify a gateway
Time ProfileSpecify the time profile of the event
OwnerIndicate the owner
Total VolumeEnter the range of total duration
Total RecordsEnter the range of total records
Not Zero RecordsDefine the range of records that have a duration equal to or more than 1 unit
ASR CurrentSpecify the range of ASR Cur for records you would like to display
ACD CurrentSpecify the range of ACD Cur for records you would like to display
Service NameDetermine the name of service for the report
Output



This form contains settings of the report output data.

Click the plus icon next to Columns and select the required columns to add them to the Output information block. Also, you can cancel any chosen item.

Accessible columns in the report

The list of additional columns include:

Columns for the main period:

Cost Total, Setup Fee Cost, Average Rate, Package Credit, Total Volume, Billed Volume, Package Volume, Total Events, Not Zero, Success, Busy, No Channel, Error, ASR Std, ASR Cur, ACD Srd, ACD Cur, PDD Avg, SCD Avg, xDRs List, Taxes Total, Additive Cost.

Columns for the comparative period are the same as for the main period. Moreover, all parameters could be selectedexpressed in percentage.

Rate

Avg. Rate - an average cost calculated

Totals
  • Cost Total - the full price of all services including additional services
  • Total Volume - a whole volume of the events in units (specified in the Services settings → "Reports" field)
  • Billed Volume -  a whole billed volume of events. It could differ from the total volume due to the rates settings, for example, grace volume, min volume, and interval.
  • Package Volume - a volume within a respective package that is billed according to the package limits
  • Package Credit - a volume of credit that has been charged within the respective package
  • Total Events - the entire quantity of events
  • Not Zero Records - the number of records that have the volume equal to or more than 1
  • Success Records - the number of records that have a duration equal to or more than 1 and a successful end code, records with Q.931 disconnect cause 16 or 31
  • Busy Records  - busy records quantity with Q.931 disconnect cause 17
  • No Channel Records - no circuit/channel available, records quantity with Q.931 disconnect cause 34
Statistics

ASR - average success rate (successful records percentage)

  • Std - the value calculated based on the records with "success" status divided by the total number of records minus all records with “no channel available” status
  • Cur - the value calculated based on the records with volume > 0 divided by the total number of records

ACD - average call duration in minutes

  • Std - the sum of all records duration divided by the number of records with "success" status
  • Cur - the sum of all records duration divided by the number of records with duration > 0

PDD Avg - average post-dial delay in report units as per Service settingsseconds

SCD Avg - average session connect delay in report units as per Service settings

Extras

seconds


xDRs List - list of detailed records statistics

Other output settings
Order by

Select parameters to sort already grouped data in columns. Here you can sort data from highest to lowest values (or vice versa) and select different values.

Type

Choose a format of the report from a drop-down list: Web/CSV/Excel XLS/Excel XLSx

Also, select a look of a table view next to the Type field:

  • Plain with total - a simple table view with an additional row with calculated totals
  • Plain - a simple table view
  • Grouped - a table view with grouped data and possibility to collapse it
Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

Please note that the Grouped type of a table view is available only for Excel XLSx and Web formats, it doesn't work with CSV and Excel XLS.


LimitDetermine the number of rows that will be visible in the report. It is useful for displaying some top positions by the chosen parameter. It is available only for the Plain report type. 
Send to

You can send generated reports via email. Also, it is possible to specify several emails.

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning) Attention

This feature is available only for CSV/Excel XLS/Excel XLSx formats of the report; it doesn't work with Web.


Currency

Specify a currency of the report. All values will be automatically converted to the specified currency in the report.

Code Deck

Select a code deck from a drop-down list. All codes in the following report will be presented according to the specified code deck.

...

Screenshot: Summary Report section

Image RemovedImage Added


If the data in the report is grouped, it will be shown initially collapsed. To expand or collapse data in your report, click the  plus or minus icons. To expand all data in the report, please click Ctrl + the icon.

...

Also, you can create a template for reports and save specified parameters by clicking on the Save Query button. A pop-up window with settings will appear, and you will need to fill in the following form. 
Screenshot: New Template form

Image RemovedImage Added

To load already existed templates while generating statistic reports, click the Load Query button in the Summary Report section. 

...

Screenshot: Summary Report section

Image RemovedImage Added 

Side-by-side report

This tool allows building a report with side-by-side sub-reports. Use it to run a comparative analysis on the same page. It's helpful for reviewing multiple parameters, totals, and compare results at different time intervals. The Compare Period option is designed to create a report that shows two sub-reports side-by-side. You can view more info about it in the article Compare Period Mode in Summary and Orig-Term ReportsHow to compare report parameters over the periods?.

To enable this option, click on the plus  icon next to the Period field and specify both intervals (Period 1/Period 2) for the report.

Screenshot: Summary Report section

Image RemovedImage Added

Then choose columns for a main and comparative period in the report Output form. When all required parameters are specified, click the Query button. 

...

Screenshot: Summary Report section

Image RemovedImage Added

(warning) Attention

  • When you use the Compare Period option in the Summary Report and Orig-Term Report sections, default chart templates will not be accessible.
  • When you select one of the Time parameters (Year, Month, Week) for the Group by field, the End date of the Period 2 will be set automatically to make intervals of Period 1 and Period 2 equal. Moreover, the End Date field of Period 2 becomes noneditable.
    Tip
    titleHow does the Compare Period work?

    Example 1:

    If you select the Period to be Today 00:00:00 til 23:59:59, the Previous Period and Previous Day values would be the same and show yesterday. The Previous Week option would display the same day last week (i.e., Monday for Monday), the Previous Month option would show the same date last month, and the Previous Year will display the same date last year.

    Example 2

    Please make sure you are defining the periods for comparison adequately. That is, for a period of a 'day', select the comparison of a 'day', for a 'month' - a 'month', etc. The general logic of the system in comparison more would be as follows:

    Example 1:

    If you select the the Period to be Today This Week, the system will take the period starting Monday 00:00:00 til and up to 23:59:59 , the Previous Period and Previous Day values would be the same and show yesterday. The Previous Week option would display the same day last week (i.e., Monday for Monday), the Previous Month option would show the same date last month, and the Previous Year will display the same date last year.

    Example 2:

    If you select the Period to be This Week, the system will take the period starting Monday 00:00:00 and up to 23:59:59 on the current day. That is if your current day is Thursday, This Week would be Monday to Thursday. The comparative periods will work accordingly, selecting the same periods from the past week, month, year. Only the Previous Day option will result in offsetting a period one day behind (if a period is Monday to Thursday, comparative would be Sunday to Wednesday).

    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    on the current day. That is if your current day is Thursday, This Week would be Monday to Thursday. The comparative periods will work accordingly, selecting the same periods from the past week, month, year. Only the Previous Day option will result in offsetting a period one day behind (if a period is Monday to Thursday, comparative would be Sunday to Wednesday).


    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning) Attention

    When you use the Compare Period option in the Summary Report and Orig-Term Report sections, default chart templates will not be accessible.

    Sharing a Report

    Each time you get a report output, the system generates a unique link in the format of "/view?id=<uniq-string>". It allows sharing data between the users, even if they belong to different resellers (the feature works similarly to Share by Link in Google Drive). 

    The link refers to the report data valid for a specific moment.

    Example: When you send a link to a report, you ensure the recipient would see the same data as you do. If you change data in the system (for example, perform rerating), the previously copied link to the report will display data valid for the moment of generation (even though the actual data is now different).

    You can also view the additional information about the generated report by hovering over the Info Image Addedicon, which is located under the Output section:

    Title

    Description

    Data PeriodStates the period set for a report
    Data Period 2States the period set for a Compare Mode
    Generated byIndicates the Role of the user who generated a report and specifies a generation time
    DurationTime spent to generate a report

    Screenshot: Summary report Info icon

    Image Added

    Knowledge Base Articles

    Content by Label
    showLabelsfalse
    spaces+KB
    showSpacefalse
    sortmodified
    reversetrue
    cqllabel = "stats_summary" and space = "KB"
    labels+stats_summary