Contents

Reporting

 

Summary

Description The “Reporting” page allows you to analyse the requests processed through your account. You can view totals for transaction amounts and the number of requests processed through a specified range of dates, for one or more of your site references.
Required user roles Developer 2, Site admin, Site user, Site user 2, Transaction admin, Transaction admin 2, View only transactions, View only transactions 2, Webservices
How to access Select “Transactions” from the left and then “Reporting“.

 


 

Generating a report

At the top of the page, you can specify the criteria for generating the report. There are a number of different options that can be used to customise the report.

 

“Report” tab

 

The “Report” tab allows you to input the required criteria for generating a report:

  • Site reference – The report will only contain transactions from this site reference.
  • Stored searches – Quickly restore the criteria of a previously-saved report.
  • Date from / Date to – Specify the time period to be analysed when the report is generated.
  • Summary types – You can include transactions by their authorisation date or settlement date.
  • Report format / Group by – These fields determine how the report is structured. For the above report, transactions would be grouped by Day, then Currency, then the Request type.
  • Output – Choose between displaying the search results on screen, or to instead download a CSV.

 

“Filters” tab

Filters are an advanced tool that can be used to make reports more specific. Only transactions meeting the ticked criteria will be included in the report.

e.g. When “GBP” and “USD” are ticked in the “Currencies” box, only transactions processed in those currencies will be included in the report generated.

 


 

Performing search and saving for later

When you are ready to perform your search, click “Generate”.

Info
The options you have selected will be retained on screen after the report is generated, allowing you to modify the chosen options and search again.

 

If you would like to save the selected search criteria and filters for future searches, click the arrow next to the “Generate” button and then click “Save”.

Note: The date range specified will not be stored in the saved search.

 

 

Here, you can enter a name and opt to share this search with any child users associated with your account (if applicable). If you would like to share the search criteria, begin to type the username of a child user and we will suggest matching users as you type. Select the usernames you would like to share the search with and click “Save” when you are done.

 

User
To store search criteria and reload them at a later time, your MyST user account must have one of the following :

  • Site admin
  • Site user
  • Site user 2
  • Transaction admin
  • Transaction admin 2
  • View only transactions
  • View only transactions 2
  • Basic user
Info
Only 20 stored searches can be stored for each MyST user account (including searches shared by parent users).

 

Managing stored searches

To make changes to stored search criteria:

  1. Select your stored search from the “Stored searches” drop-down.
  2. Make changes to the search criteria and filters, as necessary.
  3. In the drop-down menu next to the “Generate” button, click “Save”.
  4. Ensure the search name at the top is the name of the search you would like to change.
  5. Click “Save” to override the previous search with new criteria. (You will be prompted to confirm)

 

To delete a previously-stored search:

  1. Select your stored search from the “Stored searches” drop-down.
  2. In the drop-down menu next to the “Generate” button, click “Delete”.
  3. When prompted, click “Delete” to confirm.

 

 


 

On-screen report

If you have selected the “Output” as “On screen”, the search results will be displayed in your browser.

 

Amending your report criteria

You can amend your filters and grouping preferences by clicking the tabs at the top of the page. This will expand to show your original preferences.

 

Summary

Above the report, a summary is displayed, including a count and total amount value of AUTH and REFUND transactions, organised by currency:

 

Report

The full report is displayed beneath the summary:

 

 


 

CSV report

If you generate a report with “Output” set to “CSV file”, your browser will download a CSV file containing the report. This will contain a single row for the column headings, and the data is output directly underneath.