Seeq APIs and SDKs

Seeq Server REST API

The nexus of all Seeq activity is its REST API. The Seeq HTML5 application uses the REST API exclusively for all its capabilities, so any data access and analytics you see in Seeq Workbench or Organizer can be accomplished via the REST API.

Documentation for the REST API is available from the API Reference link on the upper-right "hamburger menu".

When clicked, the API Reference documentation interface will open in a separate browser tab. You can click to expand any of the main sections and explore the various endpoints.

The first thing shown for each endpoint is the JSON document that is returned when the API is invoked. Click the Model link under the Response Class section to view documentation for each returned object / field.

Parameters for the endpoint are shown next, and again you can click the Model link for any of the parameters to view documentation.

Finally, the Response Messages section contains the possible result codes and associated reasons.

You can invoke an API directly from this interface by supplying parameters and clicking the Try it out! button at the bottom of the endpoint. Note that the API will be invoked using the current user's credentials. Once invoked, you can view the resulting URL, response body, response code and response headers. This can be a quick way to explore the API or perform an advanced administrative command.

For most commands, you will need to execute them as an authenticated user. Invoke the /auth/login command to authenticate, which will return a session token in the x-sq-auth response header. You must supply this in the same x-sq-auth header for all future requests that require an authenticated user. You can see this pattern in action in the API Reference user interface by looking at the Curl section after you click Try it out!.  Note that the token returned by the login process expires after a certain amount of inactivity.  If expired, the token will no longer be valid and authentication will need to be performed again.  The inactivity timeout can be configured by setting the sessionDuration field for the user.  Additionally, the timeout can be turned off for a user by setting the value to 0.