{"__v":3,"_id":"55fca18af95c5b0d0068fdf5","category":{"__v":0,"_id":"56394a4c2fc5520d001a4db4","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:59:08.937Z","from_sync":false,"order":19,"slug":"api-reports","title":"API: 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-09-18T23:43:06.069Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"text"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"meta\": {\n    \"next_cursor\": \"ClgKKQoEbmFtZRIhGh9UZXN0IDIwMTUtMDktMTQgMjA6MjE6MDcuNzk1ODAxEidqDGRldn52aWF0ZXN0c3IXCxIKVGVzdFNldHVwMhiAgICAoN25CwwYACAA\", \n    \"more\": false\n  }, \n  \"results\": [\n    {\n      \"access\": {\n        \"org\": false, \n        \"public\": false\n      }, \n      \"meta\": {\n        \"name\": \"Minimal Report name\", \n        \"created\": \"2015-09-17T00:27:52.565683Z\", \n        \"tags\": [], \n        \"last_update\": \"2015-09-17T00:27:52.853092Z\", \n        \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n        \"description\": null\n      }, \n      \"id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RSZXBvcnQYgICAgKDDjQoM\", \n      \"groups\": [\n        {\n          \"rows\": [\n            {\n              \"location_id\": \"\", \n              \"call_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDjQgM\"\n            }, \n            {\n              \"location_id\": \"\", \n              \"call_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDjQgM\"\n            }\n          ], \n          \"name\": \"Group Name\"\n        }, \n        {\n          \"rows\": [\n            {\n              \"location_id\": \"\", \n              \"call_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDjQgM\"\n            }, \n            {\n              \"location_id\": \"\", \n              \"call_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDjQgM\"\n            }, \n            {\n              \"location_id\": \"\", \n              \"call_id\": \"agxkZXZ-dmlhdGVzdHNyFwsSClRlc3RTZXR1cDIYgICAgKDDjQgM\"\n            }\n          ], \n          \"name\": \"Group Name 2\"\n        }\n      ]\n    }, \n\t\t... list of Reports ...\n  ]\n}","name":""}]},"settings":"","auth":"required","params":[],"url":"/reports/"},"isReference":false,"order":1,"body":"Use this API to list the Reports in your account.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"import APImetrics\\n\\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\\\"your_api_key\\\")\\ncursor = None\\nmore = False\\nwhile more:\\n\\tresp = apimetrics.list_reports(cursor=cursor, limit=200)\\n\\tmore = resp['meta']['more']\\n  cursor = resp['meta']['cursor']\\n  for result in resp['results']\\n  \\tprint result['name']\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"reports","type":"endpoint","title":"List all Reports"}

getList all Reports


Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

Use this API to list the Reports in your account. [block:code] { "codes": [ { "code": "import APImetrics\n\napimetrics = APImetrics.APImetricsAPI(apimetrics_key=\"your_api_key\")\ncursor = None\nmore = False\nwhile more:\n\tresp = apimetrics.list_reports(cursor=cursor, limit=200)\n\tmore = resp['meta']['more']\n cursor = resp['meta']['cursor']\n for result in resp['results']\n \tprint result['name']\n", "language": "python" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}