{"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":"6197defc41c8040154bcbacc","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":"6197defc41c8040154bcba72","createdAt":"2020-11-03T16:46:14.694Z","version":"6197defc41c8040154bcbaea","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6197defc41c8040154bcba61","6197defc41c8040154bcba62","6197defc41c8040154bcba63","6197defc41c8040154bcba64","6197defc41c8040154bcba65","6197defc41c8040154bcba66","6197defc41c8040154bcba67","6197defc41c8040154bcba68","6197defc41c8040154bcba69","6197defc41c8040154bcba6a","6197defc41c8040154bcba6b","6197defc41c8040154bcba6c","5b34c737e0dca2000311de6a","60957f4cce403c0045a031ef","6197defc41c8040154bcba6d","6197defc41c8040154bcba6e","6197defc41c8040154bcba6f","6197defc41c8040154bcba70","6197defc41c8040154bcba71","6197defc41c8040154bcba72"],"_id":"6197defc41c8040154bcbaea","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60957f4cce403c0045a03255","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.