Fetch query report data for the specified report ID

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the result data and column metadata for a previously saved query report identified by its ID. The report ID can be obtained from Retrieve All Query Reports. The saved SQL SELECT query is re-executed with the specified pagination parameters and the results are returned. The saved report's reportName is included in the response for identification.

Request URL

https://{serverurl}/dcapi/reports/queryReports/{id}/data

Scope

DesktopCentralCloud.QueryReport.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/queryResult.v1+jsonapplication/queryResult.v1+jsonCopied!

- Path Parameters

idstringMandatory

The unique id retrieved for saved query report

- Query Parameters

startIndexstringOptional

Starting row index for pagination (1-based). Default is 1

limitstringOptional

Maximum number of rows to return per response. Value must be between 1 and 1000. Defaults to the saved report's limit when not provided

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/reports/queryReports/{id}/data \
  --header 'Accept: application/queryResult.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
reportNamestring

The report name echoed back from the request for identification

dataJSON Array

Array of row objects where each key is a column name and each value is the column value as a string

Show Sub-Attributes
JSON Object
Show Sub-Attributes
user_idstring

Example column value. Actual keys vary based on the SQL query provided in the request

first_namestring

Example column value. Actual keys vary based on the SQL query provided in the request

middle_namestring

Example column value. Actual keys vary based on the SQL query provided in the request

last_namestring

Example column value. Actual keys vary based on the SQL query provided in the request

createdtimestring

Example column value. Actual keys vary based on the SQL query provided in the request

descriptionstring

Example column value. Actual keys vary based on the SQL query provided in the request

columnDetailsJSON Array

Array of column metadata objects describing the result set columns including name and JDBC data type

Show Sub-Attributes
JSON Object
Show Sub-Attributes
columnNamestring

Name of the column in the result set as returned by the database

columnDataTypestring

JDBC java.sql.Types constant for the column. Common values: -5 (BIGINT), 4 (INTEGER), 12 (VARCHAR), 93 (TIMESTAMP)

- HTTP code 400

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Error code for invalid query. INVALID_QUERY = the saved SQL query is syntactically invalid or fails construction during re-execution

errorMessagestring

Human-readable message describing why the saved query failed validation or construction

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Error code for unauthorized access. REPORT_UNAUTHORIZED = the specified report ID was not found or the user does not have permission to access it

errorMessagestring

Human-readable message indicating the user is not authorized to access the specified query report

- HTTP code 417

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Error code for unauthorized MSP access. REPORT_UNAUTHORIZED = MSP non-admin user attempting to access query reports

errorMessagestring

Human-readable message indicating the user is not authorized as an MSP admin to access query reports

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Error code for server-side failure. INTERNAL_ERROR = an unexpected error occurred during query execution or report lookup (e.g., SQLException)

errorMessagestring

Human-readable message describing the internal server error encountered while fetching query report data

Possible Response Codes

200HTTP code
400HTTP code
401HTTP code
417HTTP code
500HTTP code

Sample Response: HTTP 200

Result of executing the saved query report's SQL query

Copied!
  {
    "reportName": "sample",
    "data": [
      {
        "user_id": "1",
        "last_name": "null",
        "description": "No Description",
        "middle_name": "null",
        "first_name": "admin",
        "createdtime": "1774255689700"
      },
      {
        "user_id": "2",
        "last_name": "null",
        "description": "No Description",
        "middle_name": "null",
        "first_name": "guest",
        "createdtime": "1774255689700"
      }
    ],
    "columnDetails": [
      {
        "columnDataType": -5,
        "columnName": "user_id"
      },
      {
        "columnDataType": 12,
        "columnName": "first_name"
      },
      {
        "columnDataType": 12,
        "columnName": "middle_name"
      },
      {
        "columnDataType": 12,
        "columnName": "last_name"
      },
      {
        "columnDataType": -5,
        "columnName": "createdtime"
      },
      {
        "columnDataType": 12,
        "columnName": "description"
      }
    ]
  }
                
Show full

Sample Response: HTTP 400

Saved SQL query is syntactically invalid or fails construction during re-execution

Copied!
  {
    "errorMessage": "Invalid query syntax or unsupported statement",
    "errorCode": "INVALID_QUERY"
  }
                
Show full

Sample Response: HTTP 401

Report ID does not exist or user does not have permission to access it

Copied!
  {
    "errorMessage": "You are not authorized to access this report",
    "errorCode": "REPORT_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 417

MSP non-admin user attempting to access query reports

Copied!
  {
    "errorMessage": "You are not authorized to access this resource",
    "errorCode": "REPORT_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 500

Unexpected error during saved query execution or report lookup

Copied!
  {
    "errorMessage": "An internal server error occurred while fetching query report data",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.