The Reports tab provides flexible metrics, custom time periods and data sets, customization, data you need for every one of your stores. Reports provide raw data, time series data, and data visualizations for any set of stacking parameters you set up.
The Reports Dashboard
In the main dashboard, you will see dynamic tiles for each one of your reports. Every tile displays the report name, number of completed runs, frequency of which the report is run, creation date, and parameters for ending the report (date, number of runs, or no end rule). You are able to organize your reports by name or creation, and assign each tile a color. Each tile is given a color by random, or by assignment, making it a great organizational tool.
If you would like to delete a report, click the trash icon and confirm the deletion. If you confirm the deletion, you will not be able to recover the report.
If you click the “Disable Report” link, the report will stop running. You can re-enable the report later.
Creating a New Report
To create a report, click the “+ New Report” button at the upper-right-hand corner of the page. Upon clicking the button, you will enter the report creation screen, where you can customize a report with any stacking set of rules and metrics. You can customize reports with the following fields:
Report Name
- Enter the name for your report. The more specific it is, the more helpful it will be, particularly if you create a large set of reports. Try using the regions, site IDs, or metrics specific to the report in your report name.
Color
-
This is the color associated with your report on the main Reports dashboard. The report color is randomly generated by default. If you’d like to organize your reports by color, you can select a different hue using the dropdown.
Site Filters
- Click this dropdown to filter your sites by their site name, external site ID (your sites may or may not have this number associated), country, state or province, and labels (if labels are configured for your account). If you leave this field blank, every one of your sites’ data will be used to calculate the report.
- The available filter values will populate in the field to the right of the dropdown based on the site filters you’ve selected.
- Click the (+) button to the right of the row to add another filter parameter. You can add as many filter rows and parameters as you want. If you wish to delete a parameter that you’ve added, click the (-) button to the right of its row.
Data Labels
- Click this dropdown to select each data label you want to include in your report. You can select any data label to use with any site filter, regardless of whether or not the sites you’ve chosen currently have that data label set up. This enables you to add a data label to a site at a later date and see historical reports for that site/ data label combination.
- Be careful if you only select data labels for sites that don’t currently have them enabled— your report will not find any data and will return blank.
- After you select the data labels you want to include, you can select the metrics you want to use for each data label in the dropdown to the right of the data label selector in each row. You can include any metric, regardless of whether or not the data label you have selected currently tracks that metric. This is so you can set up a report that will track data for a data label that you want to, in the future, have configured with that metric.
- Be careful when you select your data labels and metrics — if you select dwell, occupancy, or count tracking for data labels without those metrics configured, your report will not find any data and will return blank.
- Click the (+) button in each data label row to add an additional data label and/or metric parameter. You can add as many rows and parameters as you want, for every report. If you wish to delete a parameter you’ve added, click the (-) button in its row.
Make a Report Every
- In the “Make a Report Every” dropdown, you can select what frequency you run your reports at. You can set up reports to run in day, week, or month increments.
Start
- Click the “Start” field to select the date you want to start running your report. You can select historical or future dates to begin your runs.
End
- In the “End” section, you can select how you would like your report to finish. You can have it run forever by selecting "Never", select how many runs you want it to complete before stopping by clicking "After" (e.g., stop after 4 runs), or choose a date for it to stop on.
Hours to Include
- In the “Hours to Include” dropdown, you can choose the hours you wish to include data from. If you have business hours configured for your sites (you can create business hours in Settings), you can simply select “Business Hours” from the dropdown list. If you’d like to use custom hours, first select “Custom” from the dropdown list.
- If you select “Custom” hours, you’ll then see a row of buttons delineating Sunday through Saturday. If you’d like to apply a single set of custom hours to every day in the week, simply select those hours from the dropdown lists.
- If you want to configure your custom hours to use different sets of hours for different days, click the (+) button to add a new week row. In the new row, select the days you wish to have track a different time span, and then select that timespan from the dropdowns on the right.
- Repeat until you have as granular a custom hour set as you want.
- If you wish to exclude a day entirely, you can simply add a row, select that day, and leave the time selection dropdowns blank.
Notify When Ready
- If you, or another team member want to receive a notification each time a report completes a run, you can enter the contact email here.
Report Creation Tips: Understanding Site Filters
You do not have to filter your sites — leaving the sites filter blank will return all results. If you select multiple filters, the report will try to pull all the sites that match all of your conditions. If all conditions cannot be met by one site or set of sites, the report will return data for sites that satisfy as many of your conditions as possible.
Report Creation Troubleshooting
If you’re seeing error messages while creating reports, make sure you’re following these guidelines.
- Make sure to give your report a name that will help you differentiate it. Using the site(s), metric(s), and run frequency in the title can help.
- Every report you create must have at least one data label and associated metric selected. You can add as many as you like.
- If you use custom hours, you must enter two time values in the first week row. If you add more rows with time values, then you can mark the first row as blank.
Using a Report
After creating a report, you can view it by clicking its associated tile on the main Reports dashboard. When you click into a report, you’ll see Summary and Details. Both datasets will display the site names, IDs (if available), State/Province, Country, and Labels, along with the metrics used.
- Summary section displays your aggregate metrics across the report run’s time period.
- The Details section displays your metrics for each site in different formats.
Use the horizontal and vertical scroll to explore your data.
In the report’s black header, click the “Report Configuration” dropdown to see all of the report’s parameters (the site, region, data label, metric, and time filters you used to create it).
- The header also displays the number of times the report has been run.
- On the timeline selector in the upper right-hand part of the header, use the left and right arrows to jump back and forth through the report runs by date. Click the down arrow to view and select the full list of available report runs.
In the Summary Data table:
- Click the “Group By” dropdown to view your data by Site, State/Province, Country, or Data Label.
- Click the “Download CSV” button to download your summary (aggregate) data as a .CSV file.
In Details:
- Click the “Timecard” button to see a visual summary of your data that highlights how busy your sites are throughout the day. In the timecard, darker shaded cells denote busier times.
- Under the Timecard, there is a Metric dropdown menu. Click the dropdown menu to select the site, data label, and metric (Count, Dwell, or Occupancy buttons will appear for whichever metrics are available in the report) that you want to see count data for.
- The timecard will only display data for the time parameter of the report (the date range and time range listed in the black header). For example, if your report runs daily, the Timecard will only show one day’s numbers in its weekly display. For this reason, it’s recommended you use the Line Chart to visualize daily report data.
- If there is no data for the selected combination, the Timecard will show all counts.
- Under the Timecard, there is a Metric dropdown menu. Click the dropdown menu to select the site, data label, and metric (Count, Dwell, or Occupancy buttons will appear for whichever metrics are available in the report) that you want to see count data for.
- Click the “Line Chart” button, and you'll see a visual summary of your data that showcases how traffic levels change in your sites throughout the day.
- In the Metrics dropdown menu, select what count data (Average Dwell", "Average Occupancy", or "Count") you would like to view. You can select multiple sites to compare performance and trends across stores.
- Once you’ve selected your count, you can then choose the Site and Data Label(s). You can click on multiple Sites to compare performance and trends across stores.
- If your report is a weekly or monthly report, you can also toggle the time period to display traffic across every hour or the entire day.
- Each of your sites’ trend lines is depicted in its assigned color. You can select and stack as many sites as you want to compare.
- Click the "Data Table" button to view your data displayed by timestamps.
- Click the "Period" dropdown to view your data by 15 minutes, hourly, or daily increments.
- Click the “View” dropdown to change how your data is displayed. Select “Time Series” to see your data split up by timestamp across all sites. Select “Raw Data” to see your data split up by timestamp and by individual site.
- Click the “Download CSV” button to download your time period — or full set of — data as a .CSV file
Understanding Reports: Missing Data
If you set up a report and cannot see its data, a couple of different things might be going on.
- If the message “No reports have been generated” appears, it could be that the report you have just created is still loading its data, or the report you have created uses site/data label combinations that will be configured in the future.
- If the message “No Data for Selected Time Period” appears when you click into the report, it means that you have selected a valid set of sites and some data has been returned, but the time selection you are currently looking at has no data. This message will most likely appear in reports you’ve set up to use site/ data label combinations that have yet to be created.
Understanding Reports: Configuration Conflicts
In the case that you run into unlikely configuration conflicts, it is helpful to understand the logic reports use to filter your data. You will usually notice a configuration conflict as a report on the dashboard titled “Contradicting Filters.” You will not be able to click into this report — this is because the logic (the rules) used to create the report has been broken. Reports use AND/OR logic to filter your sites, data labels, metrics, and time parameters.
- First, it will try to match one site or set of sites to all of the criteria you’ve selected in the creation page. If it can’t match all of your filters, it will match as many as possible. However, if you have two site filters of the same kind (e.g., Site ID and Site Name) that don’t match the same site, it will try to return a site that satisfies both criteria. It will not be able to filter both of them, and no data will be returned.
- The site tile will give you a “No Site Matches Found” message. If you see this message, simply delete the report and try again with non-contradicting filters.
Comments
0 comments
Please sign in to leave a comment.