Logo

Saved Query API

Create Saved Query

Creates a new saved SQL query that can be reused later.

SecuritybearerAuth
Request
header Parameters
X-Esper-Tenant-ID
required
string <uuid>

Tenant ID

X-Esper-User-ID
required
string <uuid>

User ID

Request Body schema: application/json
required
query
required
string

SQL query to save

Responses
201

Query Successfully Saved

400

Bad request

401

Unauthorized

500

Internal server error

post/report/v0/saved-queries
Request samples
application/json
{
  • "query": "SELECT * FROM device WHERE platform = 'Android'"
}
Response samples
application/json
{
  • "content": {
    }
}

List All Saved Queries

Retrieves all saved queries for the current user.

SecuritybearerAuth
Request
header Parameters
X-Esper-Tenant-ID
required
string <uuid>

Tenant ID

X-Esper-User-ID
required
string <uuid>

User ID

Responses
200

List of saved queries

401

Unauthorized

500

Internal server error

get/report/v0/saved-queries
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get Saved Query
Retrieves a specific saved query by ID.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Query ID


 
header Parameters
X-Esper-Tenant-ID
required
string <uuid> 
Tenant ID


 
X-Esper-User-ID
required
string <uuid> 
User ID


 
Responses 
200
Saved query details


401
Unauthorized


404
Query not found


500
Internal server error


get/report/v0/saved-queries/{id}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Update Saved Query
Updates an existing saved query.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Query ID


 
header Parameters
X-Esper-Tenant-ID
required
string <uuid> 
Tenant ID


 
X-Esper-User-ID
required
string <uuid> 
User ID


 
Request Body schema: application/json
required
query
required
string
SQL query to save


 
Responses 
200
Query successfully updated


400
Bad request


401
Unauthorized


404
Query not found


500
Internal server error


put/report/v0/saved-queries/{id}
Request samples 
application/json
{
  • "query": "SELECT * FROM device WHERE platform = 'Android'"
}
Response samples 
application/json
{
  • "content": {
    }
}
Delete Saved Query
Deletes an existing saved query.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Query ID


 
header Parameters
X-Esper-Tenant-ID
required
string <uuid> 
Tenant ID


 
X-Esper-User-ID
required
string <uuid> 
User ID


 
Responses 
204
Query successfully deleted


401
Unauthorized


404
Query not found


500
Internal server error


delete/report/v0/saved-queries/{id}
Request samples 
Response samples 
application/json
{
  • "status": 0,
  • "error": "string",
  • "message": "string"
}