How to use the API
ThirdEye exposes a consistent CRUD API. This make 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.
Using 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
.
- Go to
[your_thirdeye_url]/swagger
- If your instance uses authentication, click the "Authorize" button and provide a bearer token.
- If your instance use HTTPS, switch HTTP to HTTPS.
- Try the endpoints.
Obtaining a bearer token.
If your instance use 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 in the Swagger UI.