Creates a link the dashboard or report can be accessed by. Shared link can be created for Dashboards and Reports only.

The following are the examples of HTTP status codes including errors that API can generate

Response codes

Response content


200 OK

The object with property "ShareUrl"

The shared link has been created successfully.

400 Bad Request

Shared link is not enabled for this team

To be able to create a shared link you need this option to be enabled for your team. To do so navigate to "Admin"->"Team Settings"->"Public links"

400 Bad Request

Email is invalid

The Email that was specified is invalid.

403 Forbidden

Access denied

Access to the object is denied.

404 Not Found

Object not found

The Object Key that was specified doesn't exists.

Click Try It! to start a request and see the response here!