Fetches the full details of a specific custom report by its ID. Returns all configuration details including report name, description, sub-module, selected columns, criteria, grouping, and chart metadata.
get /dcapi/reports/customReports/v2/{reportId}
https://{server-hostname}:8383/dcapi/reports/customReports/v2/{reportId}
CustomReport.READCopied!
Authorization: d92d4xxxxxxxxxxxxx15f52
The unique id of the created custom report
curl --request GET \
--url https://appdomain/dcapi/reports/customReports/v2/{reportId} \
--header 'Accept: application/selectedCustomReport.v2+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'Display name of the custom report (suffixed with _copy when saveAsNew=true)
Description of the custom report
Sub-module name (e.g., Computer, Hardware, Software)
Array of filter criteria objects applied to the report
Column ID the criteria is applied on
Array of search values for the criteria
Comparison operator used (e.g., contains, equal, greater than)
Logical operator (AND or OR) for combining with previous criteria
Criteria pattern expression (e.g., (1 AND 2) OR 3). Empty string if not set
Whether the current user can edit this report
Type of report component: Table or Chart
Array of selected column objects for table reports. Present only when componentType is Table
Column ID from the available columns API. Fetch from Get Available Columns
Display name of the column
Aggregation method applied: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG, or ACTUAL_VALUE. Defaults to ACTUAL_VALUE if not set
Array of column IDs used for grouping. Present only when componentType is Table
Chart configuration object. Present only when componentType is Chart
Chart type identifier (e.g., bar, pie, line, area, dial, pyramid, funnel). Fetch types from Get Available Charts
X-axis column configuration
Column ID for the axis. Fetch from Get Available Columns
Y-axis column configuration with aggregation
Column ID for the axis. Fetch from Get Available Columns
Aggregation method for the axis (cannot be ACTUAL_VALUE). Values: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG
Z-axis column configuration (optional, for bubble/scatter charts)
Column ID for the axis. Fetch from Get Available Columns
Aggregation method for the axis (cannot be ACTUAL_VALUE). Values: SUM, AVG, COUNT, MIN, MAX, STRING_AGG, JSON_AGG
Whether the report exceeds the configured column or criteria limits
Numeric error code: report ID not found or user is not authorized to access the report
Detailed error description indicating the specific failure
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Expectation failed error code: Custom Report V2 is not enabled
Message indicating Custom Report V2 feature is not active
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
Full details of a table-based custom report
{
"componentType": "Table",
"reportDesc": "List of all active computers with OS details",
"reportName": "Active Computers Report",
"subModule": "Computer",
"criteria": [
{
"comparator": "contains",
"logicalOperator": "AND",
"columnID": 103,
"searchValue": [
"Windows"
]
}
],
"editable": true,
"selectComponents": [
{
"columnID": 101,
"aggregation": "ACTUAL_VALUE",
"columnName": "Computer Name"
},
{
"columnID": 102,
"aggregation": "ACTUAL_VALUE",
"columnName": "IP Address"
},
{
"columnID": 105,
"aggregation": "COUNT",
"columnName": "Total Memory (MB)"
}
],
"groupby": [
101
],
"isReportCountExceeded": false,
"chartMeta": null,
"criteriaPattern": "1"
}
Full details of a chart-based custom report
{
"componentType": "Chart",
"reportDesc": "",
"reportName": "OS Distribution Chart",
"subModule": "Computer",
"criteria": [],
"editable": true,
"selectComponents": null,
"groupby": null,
"isReportCountExceeded": false,
"chartMeta": {
"yAxis": {
"columnID": "101",
"aggregation": "COUNT"
},
"xAxis": {
"columnID": "103"
},
"chartType": "pie",
"zAxis": null
},
"criteriaPattern": ""
}
Report ID not found or user not authorized
{
"errorMessage": "Unauthorized to access this custom report",
"errorCode": 40001
}
Missing or invalid authentication token
{
"errorMessage": "Authentication token is missing or invalid",
"errorCode": "401"
}
User does not have the required role
{
"errorMessage": "User does not have the required role to access this resource",
"errorCode": "403"
}
Custom Report V2 is not enabled
{
"errorMessage": "Custom Report V2 is not enabled",
"errorCode": "417"
}
Rate limit exceeded
{
"errorMessage": "Rate limit exceeded. Please retry after some time",
"errorCode": "429"
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.