{"__v":0,"_id":"55fc9b803c21291900e7e103","category":{"__v":1,"_id":"55fc9b7a3c21291900e7e0e0","pages":["55fc9b803c21291900e7e101","55fc9b803c21291900e7e102","55fc9b803c21291900e7e103","55fc9b803c21291900e7e104"],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-13T22:52:13.357Z","from_sync":false,"order":8,"slug":"results-and-reports","title":"Results and Reports"},"parentDoc":null,"project":"5553d36165e8260d0024419a","user":"5553d33065e8260d00244199","version":{"__v":12,"_id":"55fc9b793c21291900e7e0d7","project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-14T20:25:43.670Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:embed]\n{\n  \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2Fvideoseries%3Flist%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3D7t8-qKw9WY8%26index%3D3%26list%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2F7t8-qKw9WY8%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\\\" width=\\\"854\\\" height=\\\"480\\\" scrolling=\\\"no\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\",\n  \"url\": \"https://www.youtube.com/watch?v=7t8-qKw9WY8&index=3&list=PLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_\",\n  \"title\": \"APImetrics Reports\",\n  \"favicon\": \"https://s.ytimg.com/yts/img/favicon-vflz7uhzw.ico\",\n  \"image\": \"https://i.ytimg.com/vi/7t8-qKw9WY8/hqdefault.jpg\"\n}\n[/block]\nAPI call performance can be shown in custom reports which cover the following data:\n- Pass/Fail Rates\n- Average and Peak Latency\n- Latency over time\n- Trends\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Groups\"\n}\n[/block]\nGroups are sets of data grouped together under custom names, individual API calls are added to groups.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"API Calls\"\n}\n[/block]\nIndividual API calls are listed by deployment.\n\nExample: add the calls, then add the location your want to see the data from. That way you can combine and compare the results of different locations.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/2s1hVYQTl2quqgl40uNH_report%20builder.jpg\",\n        \"report builder.jpg\",\n        \"1013\",\n        \"433\",\n        \"#4c637b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Viewing Reports\"\n}\n[/block]\nOnce configured the report can be viewed from the report menu or added to your dashboard as a widget.\n\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/oCa48TZkT4ym3g7oMJBa_sample%20report.jpg\",\n        \"sample report.jpg\",\n        \"994\",\n        \"490\",\n        \"#51a193\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Report Element\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Call Name\",\n    \"0-1\": \"Name for the report\",\n    \"1-0\": \"Deployment\",\n    \"1-1\": \"Where the call was executed from\",\n    \"2-0\": \"Number of Calls\",\n    \"2-1\": \"The number of API calls made in the displayed period\",\n    \"3-0\": \"Average Latency\",\n    \"3-1\": \"Average latency of all the calls - the trend lines show if that has improved (green) or got worse (red) since the last equivalent time period\",\n    \"4-0\": \"Peak Latency\",\n    \"4-1\": \"The longest time recorded in the same for a pass or failure\",\n    \"5-0\": \"Pass Rate\",\n    \"5-1\": \"The percentage pass rate in the period\",\n    \"6-0\": \"Breakdown\",\n    \"6-1\": \"A visual representation of the breakdown of passes, warnings and fails. As most APis will have pass rates >95%, the proportion of the bar allocated to passes, warning and fails is adjusted so that you can see immediately if there is a problem with a relatively high number of warnings or fails.\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"creating-reports","type":"basic","title":"Creating Reports"}
[block:embed] { "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2Fvideoseries%3Flist%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3D7t8-qKw9WY8%26index%3D3%26list%3DPLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_&image=https%3A%2F%2Fi.ytimg.com%2Fvi%2F7t8-qKw9WY8%2Fhqdefault.jpg&key=02466f963b9b4bb8845a05b53d3235d7&type=text%2Fhtml&schema=youtube\" width=\"854\" height=\"480\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>", "url": "https://www.youtube.com/watch?v=7t8-qKw9WY8&index=3&list=PLf2DAAiR0jOYOgQLWVa6InnyzxAvisd3_", "title": "APImetrics Reports", "favicon": "https://s.ytimg.com/yts/img/favicon-vflz7uhzw.ico", "image": "https://i.ytimg.com/vi/7t8-qKw9WY8/hqdefault.jpg" } [/block] API call performance can be shown in custom reports which cover the following data: - Pass/Fail Rates - Average and Peak Latency - Latency over time - Trends [block:api-header] { "type": "basic", "title": "Groups" } [/block] Groups are sets of data grouped together under custom names, individual API calls are added to groups. [block:api-header] { "type": "basic", "title": "API Calls" } [/block] Individual API calls are listed by deployment. Example: add the calls, then add the location your want to see the data from. That way you can combine and compare the results of different locations. [block:image] { "images": [ { "image": [ "https://files.readme.io/2s1hVYQTl2quqgl40uNH_report%20builder.jpg", "report builder.jpg", "1013", "433", "#4c637b", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Viewing Reports" } [/block] Once configured the report can be viewed from the report menu or added to your dashboard as a widget. [block:image] { "images": [ { "image": [ "https://files.readme.io/oCa48TZkT4ym3g7oMJBa_sample%20report.jpg", "sample report.jpg", "994", "490", "#51a193", "" ] } ] } [/block] [block:parameters] { "data": { "h-0": "Report Element", "h-1": "Description", "0-0": "Call Name", "0-1": "Name for the report", "1-0": "Deployment", "1-1": "Where the call was executed from", "2-0": "Number of Calls", "2-1": "The number of API calls made in the displayed period", "3-0": "Average Latency", "3-1": "Average latency of all the calls - the trend lines show if that has improved (green) or got worse (red) since the last equivalent time period", "4-0": "Peak Latency", "4-1": "The longest time recorded in the same for a pass or failure", "5-0": "Pass Rate", "5-1": "The percentage pass rate in the period", "6-0": "Breakdown", "6-1": "A visual representation of the breakdown of passes, warnings and fails. As most APis will have pass rates >95%, the proportion of the bar allocated to passes, warning and fails is adjusted so that you can see immediately if there is a problem with a relatively high number of warnings or fails." }, "cols": 2, "rows": 7 } [/block]