{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Custom Reporting API Errors","type":"basic","slug":"custom-reporting-api-errors","excerpt":"","body":"The following errors can be returned in response to Custom Reporting API requests.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Code\",\n \"h-2\": \"Description\",\n \"h-1\": \"Name\",\n \"0-0\": \"21001\",\n \"0-1\": \"INVALID_INPUT\",\n \"0-2\": \"If the request contains invalid or missing data, the API returns HTTP code 400, along with information about the error.\\n\\nFor example: `title is mandatory`\",\n \"1-0\": \"21002\",\n \"1-1\": \"GENERAL_REPORT_ERROR\",\n \"1-2\": \"In case of service errors, the API returns HTTP code 500, along with this message:\\n\\n`BI Reports are currently unavailable; please try again later.`\"\n },\n \"cols\": 3,\n \"rows\": 2\n}\n[/block]","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fa1981d289031004cdb5a76","createdAt":"2020-11-03T17:49:17.068Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"5fa18956dd369d003cb51fc6","createdAt":"2020-11-03T16:46:14.694Z","version":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.36 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5fa1893ed2a2370028d2421e","5fa1893ed2a2370028d2421f","5fa1893ed2a2370028d24220","5fa1893ed2a2370028d24221","5fa1893ed2a2370028d24222","5fa1893ed2a2370028d24223","5fa1893ed2a2370028d24224","5fa1893ed2a2370028d24225","5fa1893ed2a2370028d24226","5fa1893ed2a2370028d24227","5fa1893ed2a2370028d24228","5fa1893ed2a2370028d24229","5b34c737e0dca2000311de6a","5fa1893ed2a2370028d2422a","5fa1893ed2a2370028d2422b","5fa1893ed2a2370028d2422c","5fa1893ed2a2370028d2422d","5fa1893ed2a2370028d2422e","5fa1893ed2a2370028d2422f","5fa18956dd369d003cb51fc6"],"_id":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5f4d276c4ff932005f3e3b86","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}Custom Reporting API Errors
The following errors can be returned in response to Custom Reporting API requests.
Code
Name
Description
21001
INVALID_INPUT
If the request contains invalid or missing data, the API returns HTTP code 400, along with information about the error.
For example: title is mandatory
21002
GENERAL_REPORT_ERROR
In case of service errors, the API returns HTTP code 500, along with this message:
BI Reports are currently unavailable; please try again later.
