Custom Reports
Who is this for: Partners who need tailored, on-demand reporting across one or multiple accounts.
Outcome: Create reusable report templates and generate detailed account statistics in CSV or JSON, with configurable date ranges, breakdown options, and metric selections.
Overview
This document explains how to create and run custom report templates to generate account statistics. Customizing your reports helps you gain deeper insights into your data, allowing you to track performance and make informed decisions. By following the steps outlined here, you can tailor your reports to suit your specific needs and requirements.
Prerequisites
Before using custom reports, ensure the following:
- Contact Your Account Manager: Custom reports need to be activated for your account. Please contact your account manager to enable this feature.
- Admin Access: Only users with "Admin" access can use custom reports. Users with "Manager" or "Analyst" roles don't have access to this feature.
ο»Ώ
Click Take a tour on the dashboard to start a 10-step walkthrough covering template setup, Offer Units, report type, date quantum, breakdowns, KPI columns, custom attributes, saved templates, and CSV/JSON downloads;
Creating a Template
You have the option to create any number of report templates that you can run to generate your reports. Follow the demo below to create a template:
Selecting Account(s)
Step 1: Select Accounts
- Choose up to 10 accounts to include in your report.
- By default, if no accounts are selected, the report will include all accounts related to your main account.
Step 2: Create Report Template
- After selecting the accounts, click on the "Create Report Template" button.
Specify Report Name
- A popup will appear after clicking the "Create Report Template" button.
- Enter a clear and descriptive name for your report template.
Specify Report Range in Days
- Enter the number of days for the report (e.g., 2 days will include the day before yesterday and yesterday).
- The maximum allowed range is 31 days.
We allow a maximum report range of 31 days. If you enter a number greater than 31, the range will be automatically reset to 31 days.
Select Offer Units
Choose the Offer Units to include in the report. You can select multiple units:
- Single Offer Unit (SOU)
- Description:
- Displays one Offer at a time in a carousel modal popup.
- User Interaction:
- Users can engage with each Offer by selecting the positive or negative call-to-action (CTA) buttons.
- Sources of Impressions:
- ο»ΏMomentPerks APIο»Ώ
- ο»ΏDirectPerksο»Ώ
- Multi Offer Unit (MOU)
- Description:
- Displays all available Offers simultaneously in a tile format.
- User Interaction:
- Users can view and consider multiple Offers at once. Each tile represents a distinct Offer.
- Sources of Impressions:
- Perkswall
- Description:
- Allows publishers to display several Offers/Perks at once in a branded experience. Learn more about Perskwallο»Ώ
- User Interaction:
- Users see multiple Offers in a unified branded interface.
- Sources of Impressions:
- ο»ΏPerkswall Direct OffersPerkswall Direct ο»Ώ
- ο»ΏPerkswall APIPerkswall APIο»Ώ
If you select Offer Units that are not active for your account (e.g., Perkswall), the report will still include these units but with empty values for those columns.
Specify your Report Type
Choose the type of report you want:
- Dashboard (Action-Based): This report tracks actions based on when they occurred, regardless of the original impression. For instance, if an impression happens today and its conversion occurs the following day, the impression will be recorded for today, while the conversion will be attributed to tomorrow.
- Downstream (Based on the Originating Event): This report tracks actions based on the original impression. For example, if an impression occurs today and a conversion from that impression happens tomorrow, both the impression and the conversion will be attributed to today.
Specify Date Quantum
Select date options for your report, either by day or by month. This groups the report data accordingly.
- By Month: Displays a row with each month in the selected date range and their corresponding report values.
- By Day: Displays a row with each day in the selected date range and their corresponding report values.
If you choose a date range of less than 28 days, the monthly quantum will still apply if the dates span different months.
ο»Ώ
Choose your Breakdown Method
Select one or more methods to break down your report:
- Breakdown by Accounts: Groups the report by accounts, adding a new column named "Accounts."
- Breakdown by Offer:
- Groups the report by Offers, adding a new column named "Offers."
- Breakdown by Units:
- Groups the report by units (e.g., MOU, SOU, Perkswall), adding a new column named "Units."
- Breakdown by Device:
- Groups the report by device, adding a new column named "Devices."
- Breakdown by OS:
- Groups the report by operating system, adding a new column named "OS."
If you choose to break down by Offer, you will not be able to include the following columns to your report:
- Impressions
- CTR
- RPM
These columns represent unit-wise numbers (MOU/SOU/Perkswall), not Offer-wise numbers.
Choose your Report Columns
Select the columns for your report. Note that some columns depend on others being included.
Title | Needed Items | Disabling Items | Description |
|---|---|---|---|
Placements | None | None | The placement through which the offer was served (e.g., homepage, checkout, mobile app). Use this column to break down performance by the specific surface or page in your integration where the impression occurred. |
Themes | None | None | The theme applied to the offer at the time of the impression. Use this column to compare performance across different theme configurations, which is useful for A/B testing and creative analysis. |
Views | N------------------------------one | When you select βBreakdown by Offerβ you will not be able to add the βImpressionsβ column. | The total number of times an Offer Unit (SOU, MOU, or Perkswall) was loaded. One Impression represents one unit load, regardless of how many individual offers were displayed inside it. (Labeled Views on the Dashboard.) |
Impressions | None | None | Represents each time an individual Offer is shown. (Labeled Impressions on the Dashboard.) |
Clicks | None | None | Counts each time a user clicks on an Offer. |
Conversions | Revenue | None | A conversion is recorded each time a customer converts on an Offer.
|
Revenue | None | None | The total revenue generated from customer engagement with MomentScience Offers, excluding commissions. |
CTR | Clicks, Impressions | When you select βBreakdown by Offerβ you will not be able to add βCTRβ column. | Calculated as the number of clicks divided by the number of Unit Impressions |
CTR (Offers) | Clicks, Impressions (Offers) | None | Click-through Rate for Offers, calculated as the number of clicks divided by the number of Impressions (Offers) |
CVR | Clicks, Conversions | None | Conversion Rate, defined as the number of conversions per click.
|
RPM | Impressions | When you select βBreakdown by Offerβ you will not be able to add βRPMβ column. | Measures the revenue generated per 1000 Impressions. RPM = Revenue / Impressions x 1000. |
RPM (Offers) | Impressions (Offers) | None | Measures the Revenue generated per 1000 individual Offer Impressions. RPM (Offers) = (Revenue / Impressions (Offers)) * 1000. |
RPC | Revenue, Clicks | None | The revenue per click is the revenue generated for the specified account(s) divided by the number of clicks. |
Insert Attributes
Payload values are parameters sent with the MomentScience integration to provide additional information about the user or session. Specify attribute names to include in conversion reports, aiding in the analysis of impressions and clicks. For more information on passing payload values, please refer to the Passing Payload Valuesο»Ώ
- Add multiple attributes, separated by commas.
- Ensure the attributes are correct, as they come to MomentScience as payloads.
If you insert an incorrect attribute, the report will still include a column with the attribute name, but it will contain empty values.
Preview your Report
- Preview the look of your report columns.
- Once you're done with the preview, Click on "Save Report Template" button.
The numbers shown are placeholders and not real data. They are random numbers meant to demonstrate the general appearance of the report.
Updating a Template
Once you've created a template, you can still modify it as needed. Here are the needed steps:
- Modify the Template:
- Click the update icon next to the template you want to modify.
- Edit Details:
- A popup will appear similar to the one used for creating the template. Make your changes in this popup.
- Save Changes:
- Click the "Update" button to apply your edits.
Running a Template
- Run the Template:
- Click the Run icon next to the report template you want to generate.
- Modify the Date Range:
- Set the start and end dates as per your preference.
- Ensure the date range does not exceed 31 days; otherwise, an error message will appear.
- Add Email Addresses (Optional):
- Enter multiple email addresses separated by commas.
- The report will be sent to these emails once ready.
- Click the Run Button:
- Start the report generation process.
- Wait for Generation:
- The report generation time will vary depending on the data size.
- Access the Report:
- You will receive an email from "MomentScience Helpdesk" notifying you that the report is ready for download. The email will contain the generated report.
- You can also find the report in the "Latest Report Runs" section within the dashboard where you can download the report in CSV or JSON format based on your preference.
To find a report in the Latest Report Runs section, use the search function with the Report ID or Run UUID.
Deleting a Template
Deleting a template does not remove its associated reports. Only the template itself is deleted. Here are the needed steps:
- Delete the Template:
- Click the delete icon next to the template you want to remove.
- Confirm Deletion:
- A confirmation popup will appear. Click "Confirm" to proceed with the deletion.
π’ If you're running into any issues while going through the integration process, feel free to contact us at help@momentscience.comο»Ώ