ThirdEye exposes a CRUD API. This makes it easy to use ThirdEye as a headless service from your apps. The easiest way to discover and try the different endpoints is to use Swagger.
Swagger is exposed by the coordinator at [coordinator_url]/swagger
. If you use StarTree ThirdEye or the Helm charts, Swagger is also exposed by the frontend app at [your_thirdeye_url]/swagger
.
[your_thirdeye_url]/swagger
If your instance uses authentication, the frontend passes a bearer token when performing requests. In your browser, in the devtools, you can see the bearer token.
You can copy and paste the token into the Swagger UI.
StarTree cloud users: To obtain a basic auth token for StarTree ThirdEye, contact StarTree Tech Support, and then complete step 3 below (skipping steps 1-2).
To authenticate a request, add the Authorization
header with the token value as the base64 encoded value of username:password
prefixed with Basic
.
Example:
Authorization: Basic YWRtaW46cGFzcw==
where YWRtaW46cGFzcw==
is the base64 encoded value of admin:pass
.
To encode on macOs:
Copy and paste the token YWRtaW46cGFzcw==
in the Swagger UI as Basic YWRtaW46cGFzcw==
.