Home / Get Embed URL

Get Embed URL

Tags:  

Get Embed URL


Introduction

The Get Embed URL API is used to get the embed URL of the particular table / view. This API is available only for the White Label Administrator. 

Getting Started

It is recommended to go through the Zoho Reports API Prerequisites before using Add Column API.


Request

The following is the sample request URL to get Embed URL for a view.
https://reportsapi.zoho.com/api/demouser/EmployeeDB/EmployeeDetails?ZOHO_ACTION=GETEMBEDURL &ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON &authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0

Data Sent as POST parameters:

ZOHO_CRITERIA=("Department"='Finance')

Query String Parameters

The following table shows the list of Query String parameters that has to be passed along with the request URL.

This parameters should be in the same case as given in this document.

Parameter Name Possible Values Description
ZOHO_ACTION GETEMBEDURL This parameter value should be GETEMBEDURL.   (Upper Case)

 
ZOHO_VUD_PERMISSION  true/false

Optional. Default is false.

In case it is true, then the view have the permission to view the Underlying data.

In case its false, then the view don't have the permission to view the Underlying data.

ZOHO_INCLUDE_TOOLBAR true/false

Optional. Default is false.

In case it is true, then the toolbar is visible in the embed mode.

In case its false, no toolbar is visible in the embed mode.

ZOHO_VALIDITY_PERIOD <number>

Controls the validity period of the embed url.

Optional. Default is 3600 seconds (One hour).

Value in seconds.

ZOHO_THEME_COLOR blue/brown Theme color.

Default is blue
ZOHO_DATATYPE_SYMBOL true/false

Controls to display the datatype symbol in the table column

Optional. Default is false

ZOHO_SEARCH_BOX true/false Controls to display the search box in the table 

Optional.
ZOHO_IS_SECURE true/false Controls to access the url in secure mode or not (http or https)

Optional. Default is false
ZOHO_LEGEND_POSITION 
  • RIGHT
  • LEFT
  • TOPLEFT
  • TOPRIGHT
  • TOPCENTER
  • BOTTOMLEFT
  • BOTTOMRIGHT
  • BOTTOMCENTER
  • NONE
Controls to display the position on the legend

Optional

ZOHO_EXPORT_PERMISSION

true/false

Optional. Default is false.

If set as true, then the view have the permission to export the data.

If set as false, then the view don't have the permission to export the data.

Response

The following sample response will be sent from the server after successfully adding a column.

XML Format:

<response uri="/api/your_account@zoho.com/SalesDB/Sales" action="GETEMBEDURL">
<result>
<embedurl>https://reports.zoho.com/ZDBDataSheetView.cc?&OBJID=100000000000026025&REMTOOLBAR=true&FS=OS &RSCONFIG=Ksp6SkShM5/PySm0q3lMQC4lNc6BUVBGQC4wp+YS6ahHG8e1j035yQrpZwAZdq7I </embedurl>
</result>
</response>

JSON Format:

{
"response":
{
"uri":"\/api\/your_account@zoho.com\/SalesDB\/Sales",
"action":"GETEMBEDURL",
"result": {"embedUrl":"https://reports.zoho.com/ZDBDataSheetView.cc?&OBJID=100000000000026025&REMTOOLBAR=true&FS=OS &RSCONFIG=Ksp6SkShM5/PySm0q3lMQC4lNc6BUVBGQC4wp+YS6ahHG8e1j035yQrpZwAZdq7I"}
}
}

Error Handling


This section explains about the error response sent from the Zoho Reports server on failure of GETEMBEDURL API. The sample error response is below.

XML Format:

<response uri="/api/abc@zoho.com/Employee" action="GETEMBEDURL">
<error> <code>7103</code>
<message>Database not found! Please check whether the database exists</message>
</error>
</response>

JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com\/Employee",
"action": "GETEMBEDURL",
"error":
{ "code":7103,
"message": "Database not found! Please check whether the database exists"
}
}
}

Error Codes:

The following table shows the list of error codes sent from server on failure of Add Column API Request, along with the reason and the solution for the same.

Error Code Reason Solution
7103 The database name specified in the API request URL does not exist Check the database name in the request URL and provide a valid database name
7104 The view name specified in the API request URL does not exist. Check the view name in the request URL and provide a valid view name

In case of any error other than the above said, mail the API request URL parameters and error response details to support@zohoreports.com. Zoho Reports team will get back to you with the best possible solution.


    Post a comment

    Your Name or E-mail ID (mandatory)

    Note: Your comment will be published after approval of the owner.




     RSS of this page