User Tools

Site Tools


LUCY MANUAL Applies to LUCY versions above 2.2.


Where can I create my phishing reports?

Within each campaign you will find a button that allows you to create a PDF, HTML, Word (docx) or raw CSV report based on a predefined template.

Once the report is created (please be patient - the report creation may take a few minutes) the status indicates that it is available for download (just click on the date/time to start the download):

Below is an output of a LUCY sample report using the .docx template (please note that the recipient details are not included; this is a different template):

Where can I find my report templates?

LUCY comes with one predefined report template called “Demo Phishing Report”. You find it under “Settings/Report-Templates”.

How can I edit my report templates?

You may either edit the existing template or create a new one. The template contains sections which can be freely edited. These sections can be used later in PDF, HTML or Word reports which are generated within a campaign.


You may add your own sections and also customize the title name and logo.

What variables can be used for the report?

Lucy comes with a constantly growing list of variables which are placeholders for specific statistics or graphics. You find the variables within the variable list in LUCY:

Those placeholders can be inserted in the content of any report chapter:

When you create the report within a campaign those variables will be populated with your specific campaign statistics (similar to the graphics you already know from the dashboard). Those variables are:

  1. %report.createdate% Create Date Of Report
  2. Author Of Report
  3. %startdate% Start Date & Time Of Campaign
  4. %finishdate% Finish Date & Time Of Campaign
  5. %creator% User Who Created The Campaign
  6. %file.formats% File Based Attacks: Name Of File Formats Used In Campaign Scenarios
  7. %scenarios.number% Number Of Scenarios Used In Campaign
  8. %scenarios.names% Names Of Scenarios Used In Campaign
  9. %scenarios.types% Types Of Scenarios Used In Campaign
  10. %client% Client Name
  11. %opened% Percentage Of Opened Mail
  12. %opened.count% Number Of Emails Opened
  13. %clicked% Percentage Clicked On Link
  14. %clicked.count% Number Of Emails Clicked
  15. %sent.count% Number Of Emails Sent
  16. %reported% Percentage Of Users Reported
  17. %success% Percentage Of Emails Submitted Data
  18. %success.count% Number of Emails Submitted Data
  19. %domains% Domain(s) Used In Scenario Settings
  20. %timezone% Timezone Setting Of LUCY
  21. %recipients.groups% Recipient Group Names In Campaign
  22. %awareness.names% Name Of Awareness Template Used
  23. %awareness.sent% Number Of Awareness Emails Sent
  24. %awareness.opened% Number Of Awareness Emails Opened
  25. %awareness.incomplete% Number Of Users With Incomplete Training
  26. %awareness.completed% Number Of Users Who Completed Training
  27. %questions.number% Number Of Questions In Quiz
  28. %data.number% Absolute Number & Relative Number Of Collected Data From Users
  29. Percentage 'Out Of Office' Responses
  30. %bounced% Percentage Bounced Messages
  31. %responded% Percentage Responded Recipients
  32. %recipient.count% Number of recipients
  33. %incident.count.campaign% Number of incident reports in campaign
  34. %incident.count.campaignrelated% Number of all campaign-related reports in total
  35. %incident.count.notcampaignrelated% Number of all reports not related to campaigns
  36. Number of incident reports total
  37. %logo% Logo
  38. %table.contents% Table Of Contents
  39. System Information
  40. %file.settings% File Based Attacks: Settings Table
  41. %scenarios.settings% Scenarios Settings
  42. %scenarios.filebased.settings% Filebased Scenarios Settings
  43. %message.settings% Message Template Settings
  44. %schedulers% Scheduler Settings
  45. %awareness.settings% Awareness Website Settings
  46. %data% Reports the file attack output & forms POST data
  47. %additional.fields% List Of Available Recipient Fields
  48. %victim.table% Detailed Victim Results
  49. %victim.table.opened% The list of victims who opened the email
  50. %victim.emails% Table of recipient email addresses
  51. %victim.table.osbrowsers% Browser and OS stats table
  52. %victim.table.trainingstats% Table With Columns: “Email”, “Trained”, “Trained At”, “Answers Count”, “Correct Answers”, “% Of Correct Answers”
  53. %victim.table.successclickrate% Table Columns: “Email”, “Succeeded”, “Succeeded At”, “Success Rate”, “Click Rate”
  54. %victim.table.mailstats% Table Columns: “Email”, “Email Opened”, “Mail Submitted At”, “Clicked”, “Clicked At”
  55. %quiz% Quiz Questions
  56. %analyse.stats% Analyse Statistics
  57. %benchmark.stats% Benchmark Statistics
  58. %compare.stats% Campaign Comparison Statistics
  59. %trends.stats% Trends Stats
  60. %timeline% Campaign Timeline
  61. %scenarios.table.successaction% Scenarios Success Action Table
  62. %charts% All Charts
  63. %charts.summary% Summary Chart
  64. %charts.totalstats% Total Stats Chart
  65. %charts.analyse% Analyse Stats Chart
  66. %charts.awarenesstime% Awareness Time Chart
  67. %charts.scenariotime% Scenario Time Chart
  68. %charts.scenariostats% Scenario Stats Chart
  69. %charts.dailystats% Daily Stats Chart
  70. %charts.hourlystats% Hourly Stats Chart
  71. %charts.responses% Responses Detection Chart
  72. Events Chart
  73. %charts.os% Operating System Chart
  74. %charts.browsers% Browsers Chart
  75. %charts.files% Files Chart
  76. %charts.plugins% Plugins Chart
  77. %charts.countries% Countries Chart
  78. %charts.awareness% Awareness Stats Chart
  79. %charts.clickstats% Click in First 8 Hours Chart
  80. %charts.awarenessclicks% Awareness Website Clicks Chart
  81. %charts.additional% Additional Charts
  82. %charts.custom% Custom Fields Charts
  83. %charts.stafftype% Staff Types Chart
  84. %charts.location% Locations Chart
  85. %charts.division% Divisions Chart
  86. %charts.comment% Comments Chart
  87. %charts.reports% Percentage reported/not-reported Chart
  88. %charts.reportdynamics% Reports Dynamics Over Time
  89. %charts.quizquestions% Awareness Quiz Questions Chart
  90. %charts.quizscores% Awareness Quiz Scores Chart
  91. %charts.quiztimes% Awareness Quiz Times Chart
  92. %domains.table% Domain list (table with columns: “Domain”, “Associated scenario”)
  93. %users.table% Campaign responsible users (table with columns: “User”, “User type”)
  94. Recipient groups (table with columns: “Group”, “Number of users in this group”)
  95. Recipient group to scenario association (table with columns: “Name”, “Scenario”, “Mapping”, “Recipients”)
  96. Recipient settings (table with columns: “Group Name“, “Fields”, “Values”)
  97. %campaign.scenarios.table% Table of scenarios for the campaign (table with columns: “Scenario Name”, “Scenario Type”)
  98. All Awareness Website Screenshots
  99. All Awareness Website Screenshots Table
  100. %awareness.mail% All Awareness Email Template Screenshots
  101. %message.screen% All Message Template Screenshots
  102. %landing.screen% All Landing Page Screenshots
  103. %landing.screen.table% All Landing Page Screenshots Table
  104. %message.screen#% Message Template Screenshot (# - replace to scenario sequence number)
  105. %landing.screen#% Landing Page Screenshot (# - replace to scenario sequence number)
  106. %summary% Summary report across all campaigns for the current client
  107. %summary.[type]% Summary report across all campaigns by scenario type ([type] - scenario type, example: %summary.file%). List of available scenario types:%summary.file% - File-Based
  108. %summary.mixed% - Mixed
  109. %summary.malware_test% - Technical Malware Test
  110. %summary.hyperlink% - Hyperlink
  111. - Web Based
  112. %summary.awareness% - Awareness Only
  113. %summary.usb_attack% - Portable Media Attack
  114. %summary.mail_web_test% - Mail & Web Test
  115. %summary.[period]% Summary report across all campaigns by time ([period] - time period in years or months, example: %summary.2016-2017% or %summary.11.17-12.17%)
  116. %worst.employees.[limit]% Worst employees ([limit] - number of entries to show, example: %worst.employees.10%)
  117. %worst.division.[limit]% Worst divisions ([limit] - number of entries to show, example: %worst.division.10%)
  118. %worst.location.[limit]% Worst locations ([limit] - number of entries to show, example: %worst.location.10%)
  119. %worst.staff_type.[limit]% Worst staff types ([limit] - number of entries to show, example: %worst.staff_type.10%)
  120. %worst.comment.[limit]% Worst comments ([limit] - number of entries to show, example: %worst.comment.10%)

You can see the result of using each of the above variables here.

Can I add custom parameters to my report?

Yes - with LUCY > 3.1 you can add custom parameters to your report.

How can I create raw CSV exports of my campaign data?

If you click on a campaign name you will be able to export all data to a raw CVS export:

The export then can be downloaded under support/exports:

:!: Reports in the CSV format are generated using the default separator (tabulation). Please consider this when opening CSV files - in some versions of Excel you may need to manually specify the type of separator when opening the file.

You can change the default separator in the Advanced Settings section:

Is it possible to automatically export report data?

You can have LUCY automatically create a report and send it to the email address associated with the user that created the campaign by clicking on the checkbox “After I stop the campaign, send me a report to…”. As soon as you stop the campaign the report will be mailed to that address:

Is it possible to automatically pull report data from LUCY (e.g. from your SOC)?

You can fetch all campaign statistics by using our REST API.

create_campaign_reports.txt · Last modified: 2019/08/13 08:59 by lucy