Get Free Trial
API reference
Table of contents

/handshake request

[starting from version: 2.8]

An optional request to establish a connection between the client and server sides. Sends the version of the custom data source API implemented by the front end. Expects the version of the custom data source API implemented by the back end in return.

/handshake request allows checking whether the server and the client implement the same version of the custom data source API. If the implemented versions are incompatible, you will get an appropriate notification.

Note that you need to handle the /handshake request properly to receive compatibility notifications. Find the recommended way of implementing the /handshake request here.

Request

{
"type": "handshake"
"version": string
}

The request has the following parameters:

  • type – String. The type of the request. In this case, it is "handshake".
  • version – String. The version of the custom data source API implemented by the front end.

Response

{
"version": "2.8.0"
}

The response has the following parameters:

  • version – String. The version of the custom data source API implemented by the back end.

See also

/fields request
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view