Skip to content

Reports

Reports in Velocity give you access to aggregated data. These reports are customizable through the use of filters. Reports can be sent via email and downloaded directly from Velocity.

Report Types

Velocity supports reporting of the following report types:

  • Commission
  • Customer Commission Overrides
  • Customers
  • Orders
  • Order Items
  • Payments
  • Refunds
  • Shipments
  • Shipment Items
  • Subscriptions
  • Subscription Items
  • Velocity Users

Report Sections

Each report type uses the following pieces of information to generate the report:

  • Report name
  • Timezone
  • Filters
  • Columns
  • Email address(es) to send the report to

Report name

This is a custom name used when sending the report via email and also when saving a report for later. This can be any text you want to make identifying the report easier.

Timezone

You can select the timezone for your report to be generated in. Doing so converts all time and date information of the filters and the report to the selected timezone.

Filters

Filters allow you to have more fine-grained control over the information in a report. All filters you use will be combined into the final report. For example, if you filter the orders report by user and date, the generated report will only show orders placed by that user AND placed on that date.

Date/time selection filter

The date filter can be used to either filter by a relative date range, e.g. Last week, or by a custom date range. Relative date ranges are calculated based on the date the report runs. The timezone referenced above will also be used in the information gathering process when running the report.

Columns

Each report type has a specific set of columns that will appear in the generated report. You can use the checkboxes to select which columns you would like in a report.

You can click and drag a column to choose the order the they will appear in the generated report.

Generate Report

To generate a report, select the Generate report button at the bottom of the report page. Optionally, you can enter one or more email addresses to send an email with a link to download the report once it is finished generating. If no email is provided, the report will still be generated and can be accessed from Recent reports.

Recent Reports

Recently generated reports are also accessible at the top of any report page where you can download and get a link to the report.

recent-report.png

The report will have a blue checkmark if it was generated successfully, or it will have a red X if there was an error generating it.

You can access all recent reports by selecting the Recent Reports link at the top of the report page menu.

Info

Only the reports you have generated will be visible in both the top of the page and also the Recent Reports page. Reports other users have generated will not be visible.

All generated reports will be available for 30 days after they are generated, after which they will be deleted.

Sharing Reports

Velocity reports allow you to generate a shareable link with anyone. To generate the link, select the linked chains button in Recent Reports. The link will expire in 24 hours from the time it was generated.

Save Report Templates

Once a report is configured with particular filters and fields, it can be saved as a template. Templates are available in the Saved reports section. Selecting a saved report template will apply that configuration.

Info

Saved report templates are visible to anyone that has access to the reports page.

You must supply a report name in order to save a report template.

Save a New Template

In the desktop view, all saved report templates are in the right-most column of the page. To save a new report template, select the Save new button. This will take the report name, filters, and columns that are currently selected and save it. The newly saved report will show up in the list of saved reports.

On mobile, select the Show saved reports link to see the list of saved reports and the Save New button.

Edit a Saved Report

To change the configuration of a saved report template, first select the settings you want to replace in the saved report. Then go to the three dot menu on a saved report and select Edit.

The currently selected filters and settings will overwrite the saved settings.

Schedule Reports

Velocity gives you the ability to schedule reports, so they will automatically run at certain times on certain days. This can be done via the context menu ⠇on a saved report and selecting Schedule.

Info

Scheduled reports are visible to anyone that has access to the reports page.

A pop-up will appear where you can configure the schedule for your report. The following options need to be configured to schedule a report:

  • Hour — the time you want the report to be run and sent
  • Timezone — the timezone you want the hour to refer to
  • Days — the days you want the report to run and send
  • Recipients — a comma-separated list of email addresses to send the scheduled report to

Once complete, select the Schedule button. A calendar icon will appear in the saved report where you can view and edit the scheduled reports.