{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"customReport Object","type":"basic","slug":"custom-report-object","excerpt":"","body":"### Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"1-0\": \"`title`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"**Required**\",\n    \"1-3\": \"Report title. \\n\\n**\\\" & < > # / = ! \\\\ ' )** characters not permitted.\",\n    \"2-0\": \"`info`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Optional\",\n    \"2-3\": \"Report description. \\n\\n**\\\" & < > # / = ! \\\\ ' )** characters not permitted.\",\n    \"3-0\": \"`category`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"**Required**\",\n    \"3-3\": \"The report category [code](doc:report-categories).\",\n    \"4-0\": \"`columns`\",\n    \"4-1\": \"*array*\",\n    \"4-2\": \"**Required**\",\n    \"4-3\": \"An array of objects representing the columns of the report. \\n\\nEach object contains the following parameter:\\n`name`&nbsp;&nbsp;&nbsp;*string*&nbsp;&nbsp;&nbsp;**Required**&nbsp;&nbsp;&nbsp; \\n\\nFor a list of applicable `name` values, refer to [Report Categories](doc:report-categories) and click the **Supported columns** link.\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"**Required** in [Update Custom Report](doc:update-custom-report)\",\n    \"0-3\": \"Unique identifier for the report.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n<hr>\n\n### Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"*integer*\",\n    \"0-2\": \"Unique identifier for the report.\",\n    \"1-0\": \"`title`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Report title.\",\n    \"2-0\": \"`info`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Report description.\",\n    \"3-0\": \"`category`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"The report category [code](doc:report-categories).\",\n    \"4-0\": \"`columns`\",\n    \"4-1\": \"*array*\",\n    \"4-2\": \"An array of objects representing the columns in the report.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":11,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fa1c7a08371ca00467cb3a3","createdAt":"2020-11-03T21:12:00.878Z","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}

customReport Object


Request

Property Name
Type
Required
Description

id

integer

Unique identifier for the report.

title

string

Required

Report title.

" & < > # / = ! \ ' ) characters not permitted.

info

string

Optional

Report description.

" & < > # / = ! \ ' ) characters not permitted.

category

string

Required

The report category code.

columns

array

Required

An array of objects representing the columns of the report.

Each object contains the following parameter:
name   string   Required   

For a list of applicable name values, refer to Report Categories and click the Supported columns link.


Response

Property Name
Type
Description

id

integer

Unique identifier for the report.

title

string

Report title.

info

string

Report description.

category

string

The report category code.

columns

array

An array of objects representing the columns in the report.