Retrieves custom report data for a particular custom report id

This API returns the metadata and data for a specific custom report. Include the report viewname in the VIEWNAME field to retrieve the required report.

Endpoints

post /{CRVIEW_VIEWNAME}.ec

Copy full URL

Request URL

https://{serverurl}/{CRVIEW_VIEWNAME}.ec

Scope

DesktopCentralCloud.CustomReport.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Path Parameters

CRVIEW_VIEWNAMEstringMandatory

The unique viewName of the created custom report

- Query Parameters

_FIstringOptional

First index - 1st record index (index starts from 1)[inclusive] ,Increment this param according to page limit to fetch next set/page of records

_PLstringOptional

Page length - number of records fetched per page (defaulted to 25),Max limit - 500

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/{CRVIEW_VIEWNAME}.ec \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/{CRVIEW_VIEWNAME}.ec"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("POST", "/{CRVIEW_VIEWNAME}.ec", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/{CRVIEW_VIEWNAME}.ec"
        type: POST
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/{CRVIEW_VIEWNAME}.ec' -Method POST -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

headersJSON Array

Defines the column metadata for the table

Show Sub-Attributes

JSON Object

Show Sub-Attributes

sqlTypestring

SQL data type of the column

savedWidthinteger

Column width

displayNamestring

Label for display

colIndexinteger

Index of the column in the table

columnCssstring

CSS class applied to the column for styling

isSearchEnabledboolean

Whether searching is allowed on this column

canAutoResizeboolean

Indicates if the column can be resized

sqlTblColindexstring

Index of the column in the SQL table

disabledboolean

Marks if the column is disabled

sortEnabledboolean

Indicates if sorting is allowed on the column

searchValuestring

Current search filter applied on the column

columnNamestring

Actual column name in the database

rowSelectionstring

Specifies how rows can be selected

dataJSON Array

Holds the actual row data with values for each column

Show Sub-Attributes

JSON Object

Show Sub-Attributes

cellsJSON Array

Array of values corresponding to each column in the row

Show Sub-Attributes

JSON Object

Show Sub-Attributes

valuestring

Cell value for the column

rowIdxstring

Index of the row in the table

isExportEnabledboolean

Indicates whether the table can be exported

showHeaderboolean

Determines if the column headers should be displayed

numFixedColumnsinteger

Number of fixed columns

isAdvancedSearchboolean

Shows whether advanced search is enabled

showNavigboolean

Specifies if navigation controls (pagination UI) are shown

navigationJSON Object

Contains pagination and navigation-related information

Show Sub-Attributes

startLinkIndexinteger

Start index of page links

showNextPageboolean

Flag for showing next page navigation control

hasPaginationBottomboolean

Show pagination at bottom of the table

rangearray

Page size options

isNoCountboolean

Whether total count of records is hidden

typestring

Type of pagination control

endLinkIndexinteger

End index of page links

showFirstPageboolean

Flag for showing first page navigation control

totalinteger

Total number of records

pagesinteger

Number of pages

hasPaginationTopboolean

Show pagination at top of the table

itemsPerPageinteger

How many rows per page

frominteger

Start of the range of rows currently being displayed

tointeger

End of the range of rows currently being displayed

showLastPageboolean

Flag for showing last page navigation control

prevPageIndexinteger

Index of the previous page

currentPageinteger

Current active page

showPrevPageboolean

Flag for showing previous page navigation control

templateNamestring

Template applied to render the table

colListJSON Array

List of available columns with visibility, sortability, and display properties

Show Sub-Attributes

JSON Object

Show Sub-Attributes

isChoosablestring

Whether the column can be chosen or not

displaystring

Display name for the column

namestring

Column name

isSortablestring

Whether the column is sortable

isVisiblestring

Whether the column is visible in the table

SQLTableboolean

Indicates if the data originates from an SQL table

isSearchPresentboolean

Shows whether a search option is available

rowHoverboolean

Enables highlighting when hovering over rows

sortOrderboolean

Specifies if sorting is enabled

namestring

Unique identifier/name of the table view

isScrollTableboolean

Indicates if the table supports scrolling

sortBystring

Column name by which the table is currently sorted

noRowMsgstring

Message displayed when no rows are found

TableModelJSON Object

Structured representation of table rows, columns, and settings

Show Sub-Attributes

tableModelRowsarray

Array of row data

viewColumnsarray

List of columns included in the view

columnNamesarray

Column names as defined in the database

rowSelectionTypestring

Type of row selection

uniqueIdstring

Unique identifier for this table model

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Custom report successfully executed

Copied!

  {
    "headers": [
      {
        "sqlType": "CHAR",
        "savedWidth": -1,
        "displayName": "Computer Name",
        "colIndex": 0,
        "columnCss": "sortedColumn",
        "isSearchEnabled": false,
        "canAutoResize": true,
        "sqlTblColindex": 1,
        "disabled": false,
        "sortEnabled": true,
        "searchValue": "",
        "columnName": "Resource.NAME"
      }
    ],
    "rowSelection": "none",
    "data": [
      {
        "cells": [
          {
            "value": "AdamGallagher"
          }
        ],
        "rowIdx": 0
      }
    ],
    "isExportEnabled": true,
    "showHeader": true,
    "numFixedColumns": 0,
    "isAdvancedSearch": false,
    "showNavig": false,
    "navigation": {
      "startLinkIndex": 1,
      "showNextPage": false,
      "hasPaginationBottom": true,
      "range": [
        25,
        50
      ],
      "isNoCount": true,
      "type": "SELECT",
      "endLinkIndex": 1,
      "showFirstPage": false,
      "total": 6,
      "pages": 6,
      "hasPaginationTop": 6,
      "itemsPerPage": 6,
      "from": 1,
      "to": 6,
      "showLastPage": false,
      "currentPage": 1,
      "showPrevPage": false
    },
    "templateName": "tableTemplate",
    "colList": [
      {
        "isChoosable": true,
        "display": "Computer Name",
        "name": "Resource.NAME",
        "isSortable": true,
        "isVisible": true
      }
    ],
    "SQLTable": true,
    "isSearchPresent": false,
    "rowHover": true,
    "sortOrder": true,
    "name": "CRVIEW_1746711019739",
    "isScrollTable": false,
    "sortBy": "Resource.NAME",
    "noRowMsg": "Records not found",
    "TableModel": {
      "tableModelRows": [
        [
          "Machine-1"
        ]
      ],
      "viewColumns": [
        "Resource.NAME"
      ],
      "rowSelectionType": "NONE",
      "uniqueId": "CRVIEW_1746711019739"
    }
  }

▼ Show full

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.