This is the documentation of the Security Awareness Platform API to access reports only.
\nThis API will allow reporting from every client environment. It provides access to:
\nThe report requests are limited to
\nAll requests support optional headers that will be logged for traceability in our system.
\nSupported headers are:
\nRefer to Get Saved Report List for an example
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Error Codes","slug":"error-codes"},{"content":"403 Error Details","slug":"403-error-details"},{"content":"Rate Limits","slug":"rate-limits"},{"content":"Optional Headers","slug":"optional-headers"}],"owner":"7978798","collectionId":"98bfe8e0-1e38-4c44-838b-6980fff3a060","publishedId":"SztK14zb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"555759","highlight":"61B4E4"},"publishDate":"2020-06-10T17:33:48.000Z"},"item":[{"name":"Get Standard Report List","id":"b49f1535-4bc7-47a0-91b2-fd656f50af5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"3pLz9gFr7EOa9verkBICqA=="}]},"isInherited":false},"method":"GET","header":[],"url":"http://tn-dev01/QA4/api/data/report/list","description":"This call will retrieve all the standards reports that are API compliant. \nThe call will return a table with the following information for each standard report:
\nThis call will retrieve all the standards reports that are API compliant. \nThe call will return a table with the following information for each standard report:
\n(Optional)
\n","type":"text"},{"key":"Version","value":"your-version","description":"(Optional)
\n","type":"text"}],"url":"http://tn-dev01/QA4/api/data/savedreport/list","description":"This call will retrieve all saved reports in the current environment.
\nThe call will return a table with the following information for each saved report:
\nThis call accesses the Repeat Offenders Standard Report.
\nThis call has the following parameters
\nThis call accesses the Repeat Offenders Standard Report.
\nThis call has the following parameters
\nThis call accesses the Repeat Offenders Standard Report.
\nThis call has the following parameters
\nThis call accesses the Repeat Offenders Standard Report.
\nThis call has the following parameters
\nThis call accesses a saved report of type Repeat Offenders. The Report Endpoint URL is obtained by useing the returns of Get Saved Report List.\nThis call has no parameters.
\n","urlObject":{"path":["api","data","savedreport","27"],"host":["http://tn-dev01/QA4"],"query":[],"variable":[]}},"response":[{"id":"eab8e83f-458b-467c-905d-01bde7df980d","name":"Access Happy Clicker Report (Saved Report) - Success","originalRequest":{"method":"GET","header":[],"url":"https://secure.terranovasite.com/portal/api/data/savedreport/513"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"387"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"ServerNo","value":"2"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Date","value":"Wed, 10 Jun 2020 14:32:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"reportName\": \"Q1 - Repeat Offenders\",\n \"description\": \"Phishing recipients who are \\\"Happy Clickers\\\" (greater or equal 40%).\",\n \"status\": 200,\n \"recordsCount\": 0,\n \"parameters\": [\n \"Start Date : 1/1/2020 12:00:00 AM\",\n \"End Date : 3/31/2020 12:00:00 AM\",\n \"User Simulation Score : Greater than or equal to 10%\"\n ],\n \"filters\": [],\n \"reportResults\": []\n}"}],"_postman_id":"f9b97ca6-17de-4dc8-a570-8879e11e49f5"},{"name":"Licence Information","id":"c0cb1403-d647-4c67-8bf4-84a02e15d629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"3pLz9gFr7EOa9verkBICqA=="}]},"isInherited":false},"method":"POST","header":[],"url":"http://tn-dev01/QA4/api/license/info","description":"This call will retrieve information about the current license.
\n","urlObject":{"path":["api","license","info"],"host":["http://tn-dev01/QA4"],"query":[],"variable":[]}},"response":[{"id":"b99d4bed-b29e-4206-ab2e-ee1b856a9ee0","name":"Licence Information","originalRequest":{"method":"POST","header":[],"url":"http://tn-dev01/QA4/api/license/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"487"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"ServerNo","value":"2"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-UA-Compatible","value":"IE=edge"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Date","value":"Thu, 03 Sep 2020 16:47:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1\",\n \"status\": \"Valid\",\n \"organization\": {\n \"clientName\": \"**Terranova Security\",\n \"environmentName\": \"Terranova Tests\",\n \"startDate\": \"2019-09-01T00:00:00Z\",\n \"endDate\": \"2030-09-15T23:59:59Z\",\n \"licensedSimulationCount\": \"Unlimited\",\n \"usedSimulationCount\": \"0\",\n \"licensedUserCount\": \"Unlimited\",\n \"usedUserCount\": \"4\",\n \"testSimulationThreshold\": \"5\",\n \"phishSubmitterAddinLicense\": \"Yes\",\n \"note\": \"\"\n }\n}"}],"_postman_id":"c0cb1403-d647-4c67-8bf4-84a02e15d629"},{"name":"Simulation Phishing Events Log","id":"34a17857-514d-4569-aea6-2a9af066bf6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"3pLz9gFr7EOa9verkBICqA=="}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Parameters\" : {\r\n \"From\": \"2022-04-01\",\r\n \"To\": \"2022-06-21\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://tn-dev01/QA4/api/data/report/2147","urlObject":{"path":["api","data","report","2147"],"host":["http://tn-dev01/QA4"],"query":[],"variable":[]}},"response":[],"_postman_id":"34a17857-514d-4569-aea6-2a9af066bf6e"}],"event":[{"listen":"prerequest","script":{"id":"179b7f52-4397-4b9a-90ba-cac1ce39b9e7","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"74644709-a092-4675-a287-76e312940fc0","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"http://tn-dev01/QA4"},{"key":"token","value":"3pLz9gFr7EOa9verkBICqA=="}]}