{"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` *string* **Required** \\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":"6197defc41c8040154bcbacd","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":"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}customReport Object
Property Name
Type
Required
Description
title
string
Required
Report title.
" & < > # / = ! \ ' ) characters not permitted.
info
string
Optional
Report description.
" & < > # / = ! \ ' ) characters not permitted.
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.
Property Name
Type
Description
id
integer
Unique identifier for the report.
title
string
Report title.
info
string
Report description.
columns
array
An array of objects representing the columns in the report.
