Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Analytics Report doc with sidebar UI #659

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions content/docs/reporting/analytics-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,22 @@ Save your report for quick access in the future and to avoid reconfiguring your

#### Preset Reports

Your account comes with several preset saved reports which are available from the report dropdown. All preset reports are also available through a menu by clicking the “View All Reports” button in the upper right-hand corner.
Your account comes with several preset saved reports which are available from the sidebar. All preset reports are also available through a menu by clicking the All Reports” button at the bottom of the sidebar.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consider adding that you can use a preset report as-is or use it as a starting point for a custom report which you can then save/edit. that might be obvious, I'm not sure 🤷


![Finding Preset Reports](media/analytics-report/preset.gif)

#### Your Reports

Reports that you’ve saved will also appear in the same dropdown along with preset saved reports. All saved reports are also available through a menu by clicking the “View All Reports” button in the upper right-hand corner. Saved reports are automatically shared with other users on your SparkPost account.
All saved reports are available through a modal by clicking the "All Reports” button at the bottom of the sidebar. Saved reports are automatically shared with other users on your SparkPost account.

![Finding Saved Reports](media/analytics-report/reportselection.gif)

#### Favorite Reports

For quick and easy access to your reports, you can save them as favorites by clicking the dropdown menu next to the reports in the sidebar.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May want to add "You can save both preset reports and reports you create as favorites." Also - is there a limit on favorites? If so, may want to add number of reports you can favorite. If there is no limit, I'm ok with just not mentioning a limit (leave the fact that it's unlimited undocumented) in case we add a limit later.


![Finding Saved Reports](media/analytics-report/favorite.gif)

## Scheduling Your Reports

Keep yourself and your stakeholders informed by scheduling any saved report to be emailed straight to your inbox. Reports can be scheduled to be sent on a daily, weekly, or monthly basis.
Expand All @@ -104,7 +110,7 @@ Keep yourself and your stakeholders informed by scheduling any saved report to b

## Deleting Your Reports

Reports can only be deleted by the user that created them. To delete a report, first click on “View All Reports” in the upper right-hand corner, then under the “My Reports” tab, find the report you want to delete. The delete button is found in the dropdown menu on the right side of each report.
Reports can only be deleted by the user that created them. To delete a report, first click on "All Reports” at the bottom of the sidebar, then under the “My Reports” tab, find the report you want to delete. The delete button is found in the dropdown menu on the right side of each report. You can also delete reports from the sidebar directly.

## Limits/Limitations

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/docs/reporting/media/analytics-report/preset.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.