Create customized reports

You can customize some reports to include only the data you need. You can also rename and reorder the column headings in customized reports.

If you need to create the same type of report multiple times, you can create a report template that you can reuse. See Create and manage report templates for more information.

To create a customized report

📝 Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Marketplace appears in this topic, click the grid icon > Switch to | Store, instead.

Note: If the AppDirect logo appears in the upper-left corner of the page, when Manage > Billing and Distribution, or Manage > Developer appears in this topic, click the grid icon > Switch to | Distribution, instead.

Go to one of the following locations, depending on your role:
- Marketplace Manager—Manage > Marketplace > Reports > Reports | Create Report.
- Developer—Manage > Billing And Distribution > Reports > Reports | Create Report.
- Company Administrator—Manage > Account > Reports > Reports | Create Report.
- Network Manager—Manage > Network > Reports > Reports | Create Report.
- Reseller—Manage > Reseller > Reports > Reports | Create Report.
  
  The Create Report page opens.
In the Report Details pane, enter the report name.
Under Template Name, select one of the customizable report types from the drop-down list, or type a report type name in the search field. Customizable reports are indicated by an asterisk (*) symbol.
Depending on your role, the drop-down list can also include standard reports (which have no asterisk (*) symbol next to the report type). See Create standard reports.
For a description of each report type, see Report descriptions.
(Optional) If you are a Network Administrator, a Marketplace drop-down list appears. Select the marketplace for which you are creating a report. The list of available marketplaces depends on the marketplace you are logged in to. You can select multiple marketplaces if more than one is listed. The downloadable report includes an additional column—Marketplace—that identifies the marketplace associated with each row.
(Optional) Under Customize Report Fields, select Customize report. The Choose Fields tab opens with three tabs\—choose fields, rename and reorder, and filter field.
To define the information included in the generated report, on the Choose fields tab, click any of the field categories in the left pane, then select (or clear) its corresponding fields in the right pane. Recommended fields are pre-selected.
(Optional) Click the Rename and Reorder tab to rename fields or to reorder how they appear in the report. A dialog opens with a list of all the fields you selected in the previous step. The table includes the following three columns:
- Field Name—Default name for each field.
- Field Group—Name of the group that the field belongs to, such as Users, Companies, Orders and so on.
- Custom Field Label—Where you can customize the field name.
  Do any of the following:
- Rename a field—Under Custom Field Label, enter a new name for a field. When the report is published, this new name replaces the default field name.
- Remove a field— Click the X icon in the last column. Note that you can only add a field back if you cancel the report creation and start again.
- Reorder fields—You can change the order in which fields appear as column headings in the report. Click the list icon in the first column, then drag the field up or down to the desired location

(Optional) To filter the data that is included in the report for any of the fields that you selected, click the Filter fields tab. You can use a combination of operators and values to filter data. For example, if you select the Company ID field in the Choose fields tab, you can refine the companies that are included in the report by filtering companies according to their Company ID. You can apply filters to as many fields as required. The following table lists the operator types, the actions available for each, and examples of how they modify the report.
The input for an "is any of" filter in a Text or Number field is a list of comma-separated values. If one of those values itself contains a comma, you can use a backslash to escape the comma, or put the entire value in quotes.

Operator type	Operator choices	Action	Example	Example result
Text	contains, starts with, ends with, matches, is any of	Type text in field	Company name _contains_ Acme	Report only includes data for companies whose name includes the word Acme.
Number	is between, =, \≠, >, <, >=, <=, is any of	Type text in field	Company ID >= 100	Report only includes data for company IDs that have a value that is equal to, or greater than, 100.
Date	is select period, between, =, \≠, >, <, >=, <=	Select date on calendar or select period from drop-down list	Company created On _is between_ [select date ] and [select date ]	Report only includes data for companies created between the dates you select.
Enumeration	is any of, is not any of	Select values from drop-down list	Company status _is any of_ Active	Report only includes data for companies whose status is active.
Boolean	is	Select value from drop-down list	Company Marketplace Manager is Y	Report only includes data for companies that include a user with the role Marketplace Manager

Under Report Filters, select one of the following:
- Do not use report filters—Select this option to create the report without filters.
- Use report filters—Select filters for each of the options available, depending on the report type you are creating. The following filters are available for each customizable report type:
  - Invoices Customizable
    - Invoice Status—Paid, unpaid, carried, voided, pending.
  - Orders Customizable
    - Cost—Paid, free
    - Status—Initialized, active, pending, finished, free trial, canceled, suspended, and so on
  - Payment Details Customizable
    - Exclude 100% discounts (select or clear the checkbox)
    - Line Type—Item, discount, tax, and so on
    - Payment Method—Off-platform, Paypal, credit card
    - Type—Refunds, payments
  - Payment Overview Customizable
    - Payment Method—Off-platform, Paypal, credit card
    - Type—Refunds, payments
  - Subscriptions Customizable
    - Awaiting developer response (select or clear this checkbox)
    - Cost—Paid, free
    - Status—Initialized, failed, free trial, free trial expired, active, suspended, canceled
  - Users Customizable
    - Activated—Yes, no
Under Report Scheduling, select one of the following:

Create report immediately—Click the drop-down list to select the report date range. The options are:
- Previous day—Includes data for the full (24-hour) weekday prior to the report start date.
- Previous week—Includes data for the week (Monday to Sunday) that precedes the report start date.
- Previous 7 days—Includes data for the 7 days prior to the report start date. For example, if the report start date is Wednesday, the period covered is the previous Wednesday 00:00 to Tuesday 23:59.
- Previous 31 days—Includes data from 00:00:00 on the date that you create the report, regardless of the time that you create it. For example, if you create the report at 11 a.m. on March 10, the report includes data from February 8 at 00:00:00 to March 10 at 00:00:00.
- Previous calendar month—Includes data for the calendar month that precedes the report start date. For example, if the report start date is any day in January, the report includes data for all of December.
- Previous month—Includes data for the month that immediately precedes the report start date. For example, if the report start date is January 21, the report includes data from December 21 to January 20.
- Current month—Includes data for the current month, including the report start date.
- Previous day's month—Includes data for the month in which the day prior to the report start date falls. This date range is particularly useful if you select Schedule for later to create recurring daily reports.
- Previous quarter—Includes data for the quarter that precedes the report start date.
- Current quarter—Includes data for the current quarter, including the report start date.
- Current year—Includes data for the current year, including the report start date.
- Previous 12 months—Includes data for the 12 months immediately preceding the report start date. For example, if the report start date is January 21, the report includes data from January 21 the previous year to January 20 in the current year.
- All time—Includes data since data reporting began, including the report start date.
- Custom date range—Click the calendar icons to select start and end dates. If you do not enter dates, the report includes all data from all time periods.
Schedule for later—Select the time and frequency using the following filters:
- Report date range—From the drop-down list, select a time frame for your report. The report includes only data generated within the selected time frame. The options are:
  - Previous day—Includes data for the full (24-hour) weekday prior to the report start date.
  - Previous week—Includes data for the week (Monday to Sunday) that precedes the report start date.
  - Previous 7 days—Includes data for the 7 days prior to the report start date. For example, if the report start date is Wednesday, the period covered is the previous Wednesday 00:00 to Tuesday 23:59.
    Previous 31 days—Includes data from 00:00:00 on the Report start date that you select, going back 31 days. For example, if you schedule the report to start on March 15 at 1 p.m., the report includes data from February 13 at 00:00:00 to March 15 at 00:00:00.
  - Previous calendar month—Includes data for the calendar month that precedes the report start date. For example, if the report start date is any day in January, the report includes data for December.
  - Previous month—Includes data for the month that immediately precedes the report start date. For example, if the report start date is January 21, the report includes data from December 21 to January 20.
  - Current month—Includes data for the current month, including the current date.
  - Previous day's month—Includes data for the month in which the day prior to the report start date falls. This date range is particularly useful for recurring daily reports. For example, if the report start date is January 20, the report includes month-to-date data for January. If the report start date is February 1, the previous day falls in January and the report includes data for all of January, up to the end of the day that precedes the report start date. This enables you to get daily views for the same month without having to create separate recurring reports.
  - Previous quarter—Includes data for the quarter that precedes the report start date.
  - Current quarter—Includes data for the current quarter, including the report start date.
  - Current year—Includes data for the current year, including the report start date.
  - Previous 12 months—Includes data for the 12 months immediately preceding the report start date. For example, if the report start date is January 21, the report includes data from January 21 the previous year to January 20 in the current year.
  - All time—Includes data since data reporting began, including the report start date.
- Reporting frequency—From the drop-down list, select the report frequency:
  - Run once—The report runs only once.
  - Daily—The report runs every day.
  - Weekly—The report runs every week.
  - Monthly—The report runs every month.
  - Last day of month—The first report is generated on the date and time that you select, and it includes data for the date range that you select. Subsequent reports are generated on the last day of the month.

In the Report Start Date field, click the calendar icon, then select the start date. If you are scheduling a one-time report, it is generated on the date you set here. If you are scheduling a recurring report, the date you enter here is the date on which the first report is generated. It is also the day of the month on which subsequent reports are run.
(Optional) In the Report Start Time field, select a time when you want the report to run. The report is generated on the date and time that you select. The time is set in 15-minute increments. The time zone is based on the time zone set on your computer and the date format is set according to your location. This feature is only available if you select Schedule for later.
(Optional) In the Report Start Time field, select a time when you want the report to run. The report is generated on the date and time that you select. The time is set in 15-minute increments. The time zone is based on the time zone set on your computer and the date format is set according to your location. This feature is only available if you select Schedule for later.
(Optional) Click Show Advanced Settings to access additional report-specific settings. Do any of the following:

Change the symbol that appears between columns in the report. The default symbol is a comma. To choose a different symbol, from the Custom Column Separator drop-down list, select one of the available options.
Select a date format from the Date format drop-down list. The date format option that you select determines how dates are displayed in the report’s CSV or Excel file. If you do not change the default setting (Legacy), the columns within the report that you create might use different formats, depending on the report type. If you select another option from the drop-down list, all dates are displayed in the format that you select.
From the Decimal Separator drop-down list, select the type of decimal separator for your currency. The decimal separator is used for separating integers, fractions, and thousands to display currency.
Create a template that defines the report's file name.
1. Under File Name Template, click the list icon. A search field opens.
2. Click anywhere in the search field. A list of parameters opens.
3. Select any combination of parameters from the list. When the report is created, its file name includes all of the parameters you select, in the order in which you select them. The parameters you select apply only to the report that you are currently generating. If the report is recurring, subsequent reports use the same template.
Define the header format for columns in the report. Currently, only standard CSV is available.
Select the footer format. The options are No Footer (the report has no footer) and Number of Data Rows (the number of rows is displayed in the footer).
Select the report format. The choices are:
- CSV—A comma-separated value file is created. If you select a custom column separator under Advanced Settings, it is used to separate columns in your report.
- Excel—The generated report is in Microsoft Excel format.
- CSV Quote All—The report is a CSV file in which all fields are enclosed in quotation marks.
Marketplace Managers and Network Managers may have the ability to have their report sent to an SFTP server, if one or more servers are configured. This appears as one of the following options, depending on how this feature was configured for your marketplace:
- Destination Name—If you see this option, select any of the destinations in the drop-down list. The report is sent to that location every time it is generated. Destinations in this list are configured by the Marketplace Manager (or a Network Manager with the Marketplace Manager role). See Manage report destinations for more information.
- Upload to SFTP server after report is generated—If this option is available, select it to send the report to the configured destination every time it is generated. This option only appears on the Create Report page after AppDirect configures this setting for your marketplace. Contact your AppDirect technical representative for information.(which must be configured by AppDirect)
- If you have the Marketplace Manager role and create the report from the Manage > Marketplace > Reports page, you can opt to receive an email with the download link to the report. To enable this option, select Email when generated.

Click Create Report.

If you selected Create report immediately under Report Scheduling, your report is generated and available for download. See Download reports.
If you selected Schedule for later, the report is available on the report start date that you defined under Report Scheduling.

Was this page helpful?

Tell us more…

Help us improve our content. Responses are anonymous.

Thanks

We appreciate your feedback!