The InstaDB API provides programmatic access to a comprehensive list of data. This REST API enables data querying, export, scheduling, and management operations through standard HTTP requests with JSON payloads.
\nBase URL
\n\nAuthentication
\nAll API requests require Bearer token authentication. Include your API token in the Authorization header:
\nAuthorization: Bearer YOUR_API_TOKEN
\nTo obtain an API token, contact your administrator or account manager.
\nQuick Start
\n1. Obtain your API token from your administrator
2. Explore available tables using /GetIndexDetails
3. Query data using /FetchIndexData for immediate results
4. For large exports, use /SaveQueryDataAsync + /FetchProcessingStatus + /DownloadFile
Common Workflows
\nWorkflow 1: Simple Data Query
1. Use /FetchIndexData with your SQL query
2. Receive results directly in the response
Workflow 2: Large Data Export
1. POST to /SaveQueryDataAsync with your query → receive taskId
2. Poll /FetchProcessingStatus with taskId until status=\"Completed\"
3. GET /DownloadFile with the outputFilePath to download results
Workflow 3: Paginated Data Retrieval
1. POST to /FetchPaginatingData with batchSize → receive cursorid
2. Make subsequent requests with the cursorID to get next pages
3. Continue until hasmorerecord=false
Workflow 4: Scheduled Exports
1. POST to /SaveUserQuery to save your query → receive query id
2. POST to /SaveQuerySchedule with queryid and CRON expression
3. Query runs automatically and saves results to your file storage
Rate Limits
\n- Maximum 1,000,000 records per async query export
\nError Handling
\nThe API uses standard HTTP status codes:
- 200 - Success
- 400 - Bad request (check your parameters)
- 401 - Unauthorized (check your API token)
- 403 - Forbidden (insufficient permissions)
- 404 - Resource not found
- 500 - Server errorEndFragment
Endpoint Description
\nThe FetchPaginatingData endpoint provides enhanced pagination capabilities for retrieving large datasets in manageable chunks. This endpoint maintains cursor state between requests, allowing efficient traversal through result sets without loading all data at once.
\nRequest Body
\nThe request body should be sent in JSON format and must include the following parameters:
\n- query (String, required): The SQL SELECT statement to execute.
- batchSize (Integer, required): The number of records to return per page.
- offset (Integer, required): The starting position for each page. Must be calculated as (batchSize × (page_number - 1)) + 1.
- cursorID (String, optional): The cursor identifier from a previous request to fetch the next page. Important for optimizing response time.
Response
\nThe response returns a JSON object with paginated query results and cursor information.
\n- instantjsonsresult (String): JSON string with columns and rows for the current page.
- success (Boolean): Query execution success indicator.
- timespan (Integer): Execution time in milliseconds.
- recordcount (Integer): Number of records in the current page.
- cursorid (String): Cursor identifier for retrieving the next page. Important for query optimization.
- hasmorerecord (Boolean): Indicates if additional pages are available within your account's record limit.
Note: Each user account has a maximum record limit per query (typically 1000 records) which determines when hasmorerecord becomes false.
\nHow to Paginate Through Results
\nIMPORTANT: You must calculate and update the offset for each page. The offset formula is:
- Page 1: offset = 0
- Page 2: offset = (batchSize × 1) + 1 = 11 (if batchSize is 10)
- Page 3: offset = (batchSize × 2) + 1 = 21
- Page N: offset = (batchSize × (N-1)) + 1
Step 1: Send the first request (Page 1)
POST /FetchPaginatingData
{
\"query\": \"SELECT first_name, last_name, business_email FROM universal_person WHERE LOWER(seniority_level)='cxo' LIMIT 1000\",
\"batchSize\": 10,
\"offset\": 0
}
Response (Page 1):
{
\"success\": true,
\"recordcount\": 10,
\"cursorid\": \"cursor_abc123\",
\"hasmorerecord\": true,
\"instantjsonsresult\": \"{...first 10 records...}\"
}
Step 2: Get the next page using cursorID and updated offset
POST /FetchPaginatingData
{
\"query\": \"SELECT first_name, last_name, business_email FROM universal_person WHERE LOWER(seniority_level)='cxo' LIMIT 1000\",
\"batchSize\": 10,
\"offset\": 11,
\"cursorID\": \"cursor_abc123\"
}
Response (Page 2):
{
\"success\": true,
\"recordcount\": 10,
\"cursorid\": \"cursor_def456\",
\"hasmorerecord\": true,
\"instantjsonsresult\": \"{...next 10 records...}\"
}
Step 3: Get the third page
POST /FetchPaginatingData
{
\"query\": \"SELECT first_name, last_name, business_email FROM universal_person WHERE LOWER(seniority_level)='cxo' LIMIT 1000\",
\"batchSize\": 10,
\"offset\": 21,
\"cursorID\": \"cursor_def456\"
}
Response (Page 3):
{
\"success\": true,
\"recordcount\": 10,
\"cursorid\": \"cursor_ghi789\",
\"hasmorerecord\": true,
\"instantjsonsresult\": \"{...next 10 records...}\"
}
Continue pagination with offset formula until hasmorerecord=false
\nImportant Notes:
- The offset MUST be calculated for each page using: (batchSize × (page_number - 1)) + 1
- Without updating offset, you will receive the same page 1 records repeatedly
- Always include the cursorID from the previous response for optimized performance
- Keep the query and batchSize the same across all pagination requests
- When hasmorerecord=false, you've reached your account's query record limit (not necessarily all available records)
- The query LIMIT should be set higher than your expected result set to avoid premature truncation
The LookupValues endpoint retrieves all available lookup column configurations across the entire InstaDB platform. This endpoint provides a comprehensive map of fields that have been configured as lookup columns, which are optimized for fast distinct value retrieval and filtering operations.
\nThis request does not require a request body.
\nResponse
\nThe response returns a JSON object containing lookup column configurations grouped by table and field combinations. Each key follows the format table_name.field_name.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetIndexDetails endpoint provides comprehensive metadata about all database indexes and tables accessible to the authenticated user. This endpoint returns detailed information including table names, column definitions with data types, record counts, friendly display names, and organizational groupings.
\nThis request does not require a request body.
\nResponse
\nThe response returns a JSON array of index objects, each containing comprehensive table and column metadata.
\nindexName (String): The technical name of the table/index.
\nfriendlyName (String): A human-readable display name for the table.
\ntableGroup (String): The organizational category this table belongs to.
\nrecordCount (Integer): Total number of records in the table.
\ncolumns (Array): Detailed column definitions including:
\nname (String): Column name for SQL queries
\ntype (String): Data type (text, integer, date, boolean, etc.)
\nfriendlyname (String): Human-readable column name
\ngroup (String): Column category grouping
\nsortno (Integer): Field order in result sets
\nistolower (Boolean): Whether values are stored in lowercase
\nisarray (Boolean): Whether the field contains array values
\nNote on Field Ordering:
\nThe sortno field indicates the order in which fields appear in query result sets. When you execute a SELECT * query, fields are returned in the order specified by their sortno values.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe FetchIndexData endpoint executes SQL queries synchronously and returns results directly in the API response, making it the primary method for retrieving data from InstaDB tables in real-time. This endpoint supports standard SQL SELECT syntax including WHERE clauses, joins, aggregations, and ORDER BY operations.
\nRequest Body
\nThe request body should be sent in JSON format and must include the following parameters:
\n- query (String, required): The SQL SELECT statement to execute against InstaDB tables.
- queryID (String, optional): A unique identifier for tracking or saving the query.
- batchSize (Integer, optional): Limit the number of rows returned in a single response.
- returntype (String, optional): Format of the response data (default is JSON).
Response
\nThe response returns a JSON object with query execution results.
\n- instantjsonsresult (String): A JSON string containing columns array and rows array with query results.
- success (Boolean): Indicates whether the query executed successfully.
- timespan (Integer): Query execution time in milliseconds.
- recordcount (Integer): Number of records returned in this response.
Endpoint Description
\nThe ExportDataToS3 endpoint executes a query and exports the resulting dataset directly to a specified Amazon S3 location. The data is written as a compressed or uncompressed file, enabling efficient storage and transfer. This endpoint is useful for large data exports and automated data pipelines.
\nParameters
\nquery (String, body parameter, required): The SQL query to be executed.
s3url (String, body parameter, required): The destination S3 URL where the exported file will be written.
s3accessid (String, body parameter, required): The AWS access key ID with permission to write to the specified S3 location.
s3accesskey (String, body parameter, required): The AWS secret access key associated with the access ID.
outputformat (String, body parameter, optional): Output format of the exported data. Supported values include json (default) and csv.
Example Request Body (Default JSON Output)
\n{\n \"query\": \"select * from universal_person\",\n \"s3url\": \"https://example-bucket.s3.us-east-1.amazonaws.com/upload/sample_upload_1.json.gz\",\n \"s3accessid\": \"AAAAAAAAA\",\n \"s3accesskey\": \"xxxxxxxxxxx\"\n}\n\nExample Request Body (CSV Output)
\n{\n \"query\": \"select * from universal_person limit 10\",\n \"s3url\": \"https://example-bucket.s3.us-east-1.amazonaws.com/upload/sample_upload_1.csv\",\n \"s3accessid\": \"AAAAAAAAA\",\n \"s3accesskey\": \"xxxxxxxxxxx\",\n \"outputformat\": \"csv\"\n}\n\nResponse
\nThe response returns a success indicator or an error message.
\nImportant Notes
\nThe s3url parameter must be unique for each request.
\"s3url\": \"https://example-bucket.s3.us-east-1.amazonaws.com/upload/sample_upload_1.json.gz\"
\nCompression is inferred automatically from the file extension:
\nUse .gz for gzip-compressed files
Omit the extension (e.g., use .json or .csv) if the file is uncompressed
A maximum download record limit is enforced based on your account settings
\nThe default limit is 1 million records
\nIf outputformat is omitted, the default output format is JSON
The LoadS3Data endpoint allows users to load data directly from an Amazon S3 file into InstaDB. The data is queried using the s3() function and can either be inserted into an existing user table or used to create a new table automatically.
This endpoint is useful for:
\nIngesting external datasets from S3
\nLoading large files into InstaDB for querying
\nAutomating data import pipelines
\nPOST https://instadb.ai/api/LoadS3Data\n\nquery (String, body parameter, required):
A SQL query using the s3() function to read data from an S3 file.
UserTableName (String, body parameter, optional):
The name of the destination table.
\nIf the table exists → data will be inserted
\nIf the table does not exist → a new table will be created automatically
\n{\n \"query\": \"select * from s3('https://example-bucket.s3.amazonaws.com/path/sample_file.csv.gz', 'ACCESS_KEY_ID', 'SECRET_ACCESS_KEY', 'CsvWithNames')\",\n \"UserTableName\": \"\"\n}\n\nselect * \nfrom s3(\n 'https://example-bucket.s3.amazonaws.com/path/sample_file.csv.gz',\n 'ACCESS_KEY_ID',\n 'SECRET_ACCESS_KEY',\n 'CsvWithNames'\n);\n\n{\n \"instantjsonsresult\": null,\n \"instantobjectresult\": {\n \"table_name\": \"dbcdt.chcdt_xxxxxxxxxxxxxxxxxxxxxxxxx_sample_table\"\n },\n \"success\": true,\n \"timespan\": 1600,\n \"message\": null,\n \"recordcount\": 2000000,\n \"totalrecordcount\": 0,\n \"cursorid\": null,\n \"hasmorerecord\": null\n}\n\nThe s3() function allows direct querying of files stored in Amazon S3.
Supported formats include:
\nCsvWithNames (CSV with header row)Ensure the provided AWS credentials have read access to the S3 object.
\nLarge files may take time to load depending on size and network conditions.
\nIf UserTableName is empty:
If UserTableName is provided:
The resulting table name is returned in instantobjectresult.table_name
\nThe recordcount field indicates the number of rows loaded
Endpoint Description
\nThe SaveQueryDataAsync endpoint executes SQL queries against InstaDB tables and saves the results to a file asynchronously, making it ideal for large data exports. The endpoint supports queries returning up to 1,000,000 records and returns immediately with a task identifier. This is part of a multi-step workflow for exporting large datasets.
\nRequest Body
\nThe request body should be sent in JSON format and must include the following parameters:
\n- query (String, required): The SQL SELECT statement to execute.
- queryID (String, optional): A unique identifier for the query.
- scheduleID (String, optional): An identifier linking this execution to a scheduled query.
- batchSize (Integer, optional): The number of records to process in each batch.
- returntype (String, optional): The desired output format.
- offset (Integer, optional): The starting record position.
Response
\nThe response returns a JSON object containing the task identifier.
\n- taskId (String): A unique identifier for monitoring query progress.
\nComplete Workflow for Large Data Export
\nStep 1: Start the async query
POST /SaveQueryDataAsync
{
\"query\": \"SELECT first_name, last_name, company_name FROM universal_person WHERE LOWER(seniority_level)='cxo' LIMIT 2000\"
}
Response:
{
\"taskId\": \"429a2eea-4816-46dc-9b0d-7cad7a7b070d\"
}
Step 2: Check processing status (poll every 5-10 seconds)
GET /FetchProcessingStatus?taskId=429a2eea-4816-46dc-9b0d-7cad7a7b070d
Response when still processing:
{
\"status\": \"Running\",
\"percentComplete\": 45,
\"recordsProcessed\": 900
}
Response when complete:
{
\"status\": \"Completed\",
\"percentComplete\": 100,
\"recordsProcessed\": 2000,
\"outputFilePath\": \"/exports/user_624510db/query_results_20251027.csv\"
}
Step 3: Download the results file
GET /DownloadFile?filePath=/exports/user_624510db/query_results_20251027.csv
This workflow is recommended for queries returning more than 1,000 records or when you need to save results for later use.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe FetchProcessingStatus endpoint monitors the progress and completion status of asynchronous queries initiated through SaveQueryDataAsync. This endpoint provides real-time updates on query execution including percentage complete and records processed. This is Step 2 in the async query workflow.
\nParameters
\n- taskId (String, query parameter, required): The unique task identifier returned by SaveQueryDataAsync.
\nResponse
\nThe response returns a JSON object with detailed status information.
\n- status (String): Current status (Running, Completed, Failed).
- percentComplete (Integer): Progress percentage (0-100).
- recordsProcessed (Integer): Number of records processed so far.
- estimatedTimeRemaining (Integer): Estimated seconds until completion.
- errorMessage (String): Error details if the query failed.
- outputFilePath (String): Path to the result file when completed.
How to Use This Endpoint
\n1. After calling SaveQueryDataAsync, save the taskId from the response
2. Poll this endpoint every 5-10 seconds with the taskId
3. Check the status field in the response
4. When status=\"Completed\", use the outputFilePath with /DownloadFile to download results
5. If status=\"Failed\", check the errorMessage field for details
Example Usage
\nFirst call (query still running):
GET /FetchProcessingStatus?taskId=429a2eea-4816-46dc-9b0d-7cad7a7b070d
Response:
{
\"status\": \"Running\",
\"percentComplete\": 65,
\"recordsProcessed\": 6500,
\"estimatedTimeRemaining\": 15
}
Second call (query completed):
GET /FetchProcessingStatus?taskId=429a2eea-4816-46dc-9b0d-7cad7a7b070d
Response:
{
\"status\": \"Completed\",
\"percentComplete\": 100,
\"recordsProcessed\": 10000,
\"outputFilePath\": \"/exports/user_624510db/query_results_20251015.csv\"
}
Next Step: Use the outputFilePath with /DownloadFile to retrieve your data.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Required)
\n","type":"text/plain"},"key":"taskId","value":"429a2eea-4816-46dc-9b0d-7cad7a7b070d"}],"variable":[]}},"response":[{"id":"88e705a6-3ded-47dc-a3ff-0e2957da2bd8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://instadb.ai/api/FetchProcessingStatus?taskId=429a2eea-4816-46dc-9b0d-7cad7a7b070d","protocol":"https","host":["instadb","ai"],"path":["api","FetchProcessingStatus"],"query":[{"key":"taskId","value":"429a2eea-4816-46dc-9b0d-7cad7a7b070d","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Thu, 16 Oct 2025 03:49:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"taskid\": \"429a2eea-4816-46dc-9b0d-7cad7a7b070d\",\n \"processrecordcount\": 0,\n \"progresspercentage\": 0,\n \"totalprocessrecordcount\": 0,\n \"files\": [\n \"{{baseurl}}/DownloadFile?filepath=https://instadb-output-files.s3.us-east-2.amazonaws.com//429a2eea-4816-46dc-9b0d-7cad7a7b070d.csv\"\n ],\n \"startat\": \"2025-10-15T17:16:47.2045155-04:00\",\n \"success\": true,\n \"timespan\": 1332,\n \"message\": \"done\",\n \"recordcount\": 0,\n \"totalrecordcount\": 0,\n \"cursorid\": null,\n \"hasmorerecord\": null\n}"}],"_postman_id":"c1cc0298-7c98-4d3a-acc1-120c72dc8582"}],"id":"8451678b-e52f-4bb2-8599-47008993ae7e","_postman_id":"8451678b-e52f-4bb2-8599-47008993ae7e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe DownloadFile endpoint enables users to download files that have been previously generated and saved through query executions or data exports. This is typically the final step in the async query workflow, after receiving an outputFilePath from FetchProcessingStatus.
\nParameters
\n- filePath (String, query parameter, required): The full server path to the file that should be downloaded. This path is obtained from the outputFilePath field in FetchProcessingStatus response or from GetUserSavedFileList.
\nResponse
\nThe response streams the file binary data with appropriate content-type headers.
\nHow to Get the filePath
\nMethod 1: From async query workflow
1. Run SaveQueryDataAsync → get taskId
2. Poll FetchProcessingStatus with taskId
3. When complete, use the outputFilePath from the response
Method 2: From saved file list
1. Call GetUserSavedFileList to see all your saved files
2. Use the file path from the list
Example Workflow
\nStep 1: Complete an async query
After FetchProcessingStatus returns:
{
\"status\": \"Completed\",
\"outputFilePath\": \"/exports/user_624510db/query_results_20251015.csv\"
}
Step 2: Download the file
GET /DownloadFile?filePath=/exports/user_624510db/query_results_20251015.csv
The file will download with the appropriate filename and content type.
\nNote: File paths must exactly match the path provided by the system. Do not modify or construct file paths manually.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetEventDates endpoint retrieves available date partitions and record counts for tables organized by event dates or time periods. This endpoint is useful for time-series data analysis and understanding temporal distribution of records.
\nParameters
\nResponse
\nThe response returns a JSON array containing date information and record counts. Returns an empty array if the table doesn't have date-based partitioning or if no records exist.
\nNote: Most tables in InstaDB do not use date-based partitioning. Tables like marketperson_b2b have event date fields and will return populated results.
\nExample with marketperson_b2b:
\nGET /GetEventDates?table=marketperson_b2b
\nResponse:
[
{
\"table_Name\": \"marketperson_b2b\",
\"event_Date\": \"2025-10-15\",
\"record_Count\": 15000,
\"partition_Field\": \"event_date\"
},
{
\"table_Name\": \"marketperson_b2b\",
\"event_Date\": \"2025-10-16\",
\"record_Count\": 18500,
\"partition_Field\": \"event_date\"
}
]
(Required)
\n","type":"text/plain"},"key":"table","value":"marketperson_b2b"}],"variable":[]}},"response":[{"id":"497cc968-ddea-4f82-9b6b-7a43502b6586","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Endpoint Description
\nThe GetRecordCount endpoint retrieves record counts for a specific table, showing both the user's accessible record count and the full table record count. The difference between these counts indicates whether filters are applied to the table based on the user's permissions or access restrictions.
\nParameters
\nResponse
\nThe response returns a JSON object with two count values:
\nuser_recordcount (Integer): The number of records accessible to the current user. This may be filtered based on permissions or table-level filters (e.g., personal_state='CA').
\nfull_recordcount (Integer): The total number of records in the table without any user-specific filters applied.
\nNote: If user_recordcount differs from full_recordcount, it indicates that filters are applied to restrict the user's view of the table data.
\nExample Response:
\n{
\"user_recordcount\": 262176287,
\"full_recordcount\": 262176287
}
In this example, both counts are equal, indicating no filters are applied for this user.
\nExample with Filters:
\n{
\"user_recordcount\": 15000000,
\"full_recordcount\": 262176287
}
In this example, the user can only access 15 million records (e.g., filtered by personal_state='CA'), while the full table contains 262 million records.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetUserTotalRecordCount endpoint retrieves the total number of records accessible to the current user across ALL tables in the InstaDB system. This provides an aggregate count spanning all available tables, unlike /GetRecordCount which returns counts for a single specific table.
\nThis request does not require any parameters or request body.
\nResponse
\nThe response returns a single integer representing the total record count across all tables that the user has access to.
\nExample Response:
\n262176287
\nNote: This is the sum of all user_recordcount values across all accessible tables. If table-level filters are applied to the user's account, this count reflects only the filtered records the user can access.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe getDistinctValues endpoint retrieves all unique values for a specified field within a table, along with record counts for each distinct value. This endpoint is essential for populating filter dropdowns and understanding data distribution.
\nParameters
\n- IndexName (String, query parameter, required): The name of the table/index to query.
- FieldName (String, query parameter, required): The specific field to retrieve distinct values from.
- LeadingValue (String, query parameter, optional): Filter results to values starting with this prefix.
- Subquery (String, query parameter, optional): Additional SQL constraints.
Response
\nThe response returns a JSON array of objects, each representing a distinct value with its metadata.
\n- fieldname (String): The name of the field being analyzed.
- value (String): The raw value as stored in the database.
- displayvalue (String): A formatted version suitable for display.
- recordcount (Integer): The number of records containing this value.
(Required)
\n","type":"text/plain"},"key":"IndexName","value":"universal_person"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"FieldName","value":"gender"},{"disabled":true,"key":"LeadingValue","value":"string"},{"disabled":true,"key":"Subquery","value":"string"}],"variable":[]}},"response":[{"id":"087a047d-1279-47c5-a9a1-65529b627742","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://instadb.ai/api/getDistinctValues?IndexName=universal_person&FieldName=gender","protocol":"https","host":["instadb","ai"],"path":["api","getDistinctValues"],"query":[{"key":"IndexName","value":"universal_person","description":"(Required) "},{"key":"FieldName","value":"gender","description":"(Required) "},{"key":"LeadingValue","value":"string","disabled":true},{"key":"Subquery","value":"string","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Thu, 16 Oct 2025 03:48:52 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"fieldname\": null,\n \"value\": \"\",\n \"displayvalue\": \"\",\n \"recordcount\": 21048788\n },\n {\n \"fieldname\": null,\n \"value\": \"f\",\n \"displayvalue\": \"F\",\n \"recordcount\": 129331598\n },\n {\n \"fieldname\": null,\n \"value\": \"m\",\n \"displayvalue\": \"M\",\n \"recordcount\": 121265600\n },\n {\n \"fieldname\": null,\n \"value\": \"u\",\n \"displayvalue\": \"U\",\n \"recordcount\": 22258179\n }\n]"}],"_postman_id":"0f8344a6-a8aa-4913-bc00-ea83bbb60d46"}],"id":"11e0948f-f9ad-4b01-9823-631238a5f5d8","_postman_id":"11e0948f-f9ad-4b01-9823-631238a5f5d8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetLookupValues endpoint retrieves distinct values specifically for fields that have been configured as lookup columns, providing optimized performance for frequently accessed dropdown and filter values.
\nParameters
\n- IndexName (String, query parameter, required): The name of the table containing the lookup column.
- FieldName (String, query parameter, required): The name of the lookup column field.
- LeadingValue (String, query parameter, optional): Filter to values starting with this prefix.
- Subquery (String, query parameter, optional): Additional filtering constraints.
Response
\nThe response returns a JSON array of lookup value objects with record counts.
\n- fieldname (String): The lookup column field name.
- value (String): The raw stored value.
- displayvalue (String): The formatted display value.
- recordcount (Integer): Number of records with this value.
(Required)
\n","type":"text/plain"},"key":"IndexName","value":"universal_person"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"FieldName","value":"seniority_level"},{"disabled":true,"key":"LeadingValue","value":"string"},{"disabled":true,"key":"Subquery","value":"string"}],"variable":[]}},"response":[{"id":"970839af-ceb8-4ea8-ae17-a629daa3d69d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://instadb.ai/api/GetLookupValues?IndexName=universal_person&FieldName=seniority_level","protocol":"https","host":["instadb","ai"],"path":["api","GetLookupValues"],"query":[{"key":"IndexName","value":"universal_person","description":"(Required) "},{"key":"FieldName","value":"seniority_level","description":"(Required) "},{"key":"LeadingValue","value":"string","disabled":true},{"key":"Subquery","value":"string","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Thu, 16 Oct 2025 03:49:39 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"\",\n \"displayvalue\": \"\",\n \"recordcount\": 170327022\n },\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"cxo\",\n \"displayvalue\": \"Cxo\",\n \"recordcount\": 14463506\n },\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"director\",\n \"displayvalue\": \"Director\",\n \"recordcount\": 6331404\n },\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"manager\",\n \"displayvalue\": \"Manager\",\n \"recordcount\": 23389915\n },\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"staff\",\n \"displayvalue\": \"Staff\",\n \"recordcount\": 75568397\n },\n {\n \"fieldname\": \"seniority_level\",\n \"value\": \"vp\",\n \"displayvalue\": \"Vp\",\n \"recordcount\": 3823921\n }\n]"}],"_postman_id":"9a4b81d1-4c1a-4936-8184-f0b45deca7ca"}],"id":"64db1624-5057-4db4-80b6-b2fc0781fb5a","_postman_id":"64db1624-5057-4db4-80b6-b2fc0781fb5a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe SaveUserQuery endpoint (POST method) creates a new saved query in the user's query library, allowing frequently used queries to be stored and reused without rewriting SQL. Saved queries can be executed on-demand or scheduled for automatic execution.
\nRequest Body
\nThe request body should be sent in JSON format with the following parameters:
\nqueryname (String, required): A descriptive name for the saved query.
\nquerydesc (String, optional): A detailed description of what the query does.
\nindexname (String, required): The primary table this query operates on.
\nquerysql (String, required): The complete SQL SELECT statement.
\nqueryjson (String, required): JSON representation of query filters and parameters. Can be empty string if not needed.
\nsavetable (Integer, optional): Flag indicating if results should be saved to a table.
\nResponse
\nThe response returns the created query object with a generated unique ID.
\nHow to Use Saved Queries
\nUse Case 1: Save a query for reuse
POST /SaveUserQuery
{
\"queryname\": \"Monthly CXO Export\",
\"querydesc\": \"All C-level executives for monthly outreach\",
\"indexname\": \"universal_person\",
\"querysql\": \"SELECT first_name, last_name, business_email FROM universal_person WHERE LOWER(seniority_level)='cxo'\",
\"queryjson\": \"\",
\"savetable\": 0
}
Response:
{
\"id\": \"query_abc123\",
\"queryname\": \"Monthly CXO Export\",
...
}
Use Case 2: Schedule the saved query
After saving, use the query id with SaveQuerySchedule:
POST /SaveQuerySchedule
{
\"queryid\": \"query_abc123\",
\"cronexpression\": \"0 9 1 * *\",
\"startdate\": \"2025-11-01T00:00:00Z\",
\"active\": true
}
This will run your saved query automatically on the 1st of every month at 9 AM.
\nNext Steps:
\nView all saved queries with /ListUserQuery or /GetUserQueryList
\nSchedule a saved query with /SaveQuerySchedule
\nUpdate a saved query with /SaveUserQuery (PUT method)
\nDelete a saved query with /DeleteUserQuery
\nEndpoint Description
\nThe SaveUserQuery endpoint (PUT method) updates an existing saved query with modified details, allowing users to refine query definitions, update SQL statements, or change metadata.
\nRequest Body
\nThe request body should be sent in JSON format with all query fields:
\n- id (String, required): The unique identifier of the query to update.
- queryname (String, required): Updated query name.
- querydesc (String, optional): Updated description.
- indexname (String, required): The table this query targets.
- querysql (String, required): Updated SQL statement.
- queryjson (String, required): Updated JSON query representation. Can be empty string if not needed.
- savetable (Integer, optional): Save results flag.
Response
\nThe response returns the updated query object with the modified timestamp.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe ListUserQuery endpoint retrieves all queries saved by the authenticated user, providing a complete inventory of the user's query library.
\nThis request does not require a request body.
\nResponse
\nThe response returns a JSON array containing all saved queries belonging to the user, including query metadata such as names, descriptions, SQL statements, and creation dates.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe DeleteUserQuery endpoint permanently removes a saved query from the user's query library. This action is irreversible and will also delete any associated schedules that reference this query.
\nParameters
\n- queryid (String, query parameter, required): The unique identifier of the query to be deleted.
\nResponse
\nThe response returns a success indicator or error message.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe DeleteSchedule endpoint removes an existing scheduled query from the system. This action stops any future executions of the scheduled job. If specified, it can also delete the underlying saved query associated with the schedule. This action is irreversible.
\nParameters
\nscheduleid (String, query parameter, required): The unique identifier of the scheduled job to be deleted.
deletequery (Boolean, query parameter, optional): If set to true, the associated saved query will also be deleted.
Response
\nThe response returns a success indicator (with scheduleid is deleted) or an error message.
\n","urlObject":{"protocol":"https","path":["api","DeleteSchedule"],"host":["instadb","ai"],"query":[{"key":"scheduleid","value":"2145472a-61c6-4258-84ab-31bab59937ca"},{"key":"deletequery","value":"true"}],"variable":[]}},"response":[{"id":"522b3cca-4bc2-47c9-8f23-96a8982ce52b","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://instadb.ai/api/DeleteSchedule?scheduleid=2145472a-61c6-4258-84ab-31bab59937ca&deletequery=true","protocol":"https","host":["instadb","ai"],"path":["api","DeleteSchedule"],"query":[{"key":"scheduleid","value":"2145472a-61c6-4258-84ab-31bab59937ca"},{"key":"deletequery","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Sun, 22 Mar 2026 22:26:22 GMT"}],"cookie":[],"responseTime":null,"body":"2145472a-61c6-4258-84ab-31bab59937ca is deleted"}],"_postman_id":"7a78c578-555c-4ee1-ba21-6714ce22d520"}],"id":"ab615503-5aed-451e-8555-cb331db0a484","_postman_id":"ab615503-5aed-451e-8555-cb331db0a484","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe SaveQuerySchedule endpoint (POST method) creates a new automated schedule for executing a saved query at specified intervals using CRON expression syntax. This enables automated data exports, recurring reports, and scheduled data synchronization without manual intervention.
\nRequest Body
\nThe request body should be sent in JSON format with schedule configuration:
\ncronexpression (String, required): CRON format schedule (e.g., \"0 9 * * *\" for daily at 9 AM).
\nqueryid (String, required): The ID of the saved query to execute on schedule.
\nstartdate (Date, required): When the schedule should begin executing.
\nenddate (Date, optional): When the schedule should stop (null for indefinite).
\nactive (Boolean, required): Whether the schedule is enabled.
\nuserid (String, required): The user ID creating the schedule.
\nemail (String, required): Email for notifications about schedule execution.
\nResponse
\nThe response returns the created schedule object with generated ID and next run time.
\nComplete Scheduling Workflow
\nStep 1: Create a saved query
POST /SaveUserQuery
{
\"queryname\": \"Weekly Sales Leads\",
\"indexname\": \"universal_person\",
\"querysql\": \"SELECT * FROM universal_person WHERE LOWER(seniority_level)='vp' AND department='sales'\",
\"queryjson\": \"\"
}
Response:
{
\"id\": \"query_xyz789\"
}
Step 2: Create a schedule for the saved query
POST /SaveQuerySchedule
{
\"cronexpression\": \"0 9 * * 1\",
\"queryid\": \"query_xyz789\",
\"startdate\": \"2025-10-23T00:00:00Z\",
\"enddate\": null,
\"userid\": \"624510db-9169-4499-810f-d2ffa6db22cc\",
\"email\": \"user@example.com\",
\"active\": true
}
Response:
{
\"id\": \"schedule_abc123\",
\"nextrun\": \"2025-10-28T09:00:00Z\"
}
Step 3: Monitor scheduled executions
\nView all schedules with /GetUserScheduleList
\nCheck saved files with /GetUserSavedFileList
\nDownload results with /DownloadFile
\nCRON Expression Examples:
\n\"0 0 */1 * *\" - Daily at midnight
\n\"0 0 */7 * MON\" - Weekly on Monday at midnight
\n\"0 9 * * *\" - Daily at 9 AM
\n\"0 9 * * 1\" - Every Monday at 9 AM
\n\"0 0 1 * *\" - First day of every month at midnight
\n\"0 */6 * * *\" - Every 6 hours
\nManaging Schedules:
\nUpdate a schedule with /SaveQuerySchedule (PUT method)
\nView schedules with /GetUserScheduleList
\nScheduled query results are automatically saved to your file storage
\nEndpoint Description
\nThe SaveQuerySchedule endpoint (PUT method) modifies an existing query schedule, allowing users to change execution frequency, update CRON expressions, or activate/deactivate schedules. Use this endpoint to update an existing schedule - all fields must be provided, including the schedule ID.
\nRequest Body
\nThe request body should be sent in JSON format with all schedule fields:
\n- id (String, required): The unique identifier of the schedule to update.
- cronexpression (String, required): Updated CRON schedule expression.
- queryid (String, required): The associated query ID.
- startdate (Date, required): Updated start date.
- enddate (Date, optional): Updated end date.
- active (Boolean, required): Schedule enabled/disabled status.
- lastupdated (Date, optional): Timestamp of last modification.
Response
\nThe response returns the updated schedule object with recalculated next run time.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetUserScheduleList endpoint retrieves query schedules associated with the authenticated user's account, providing visibility into automated query executions and their configurations. This endpoint can be called without any parameters to return all schedules, or with an optional queryid to filter results.
\nParameters
\nResponse
\nThe response returns a JSON object containing schedule data in a structured format including CRON expressions, next execution times, and schedule status.
\nExample Usage:
\nGet all schedules:
GET /GetUserScheduleList
Get schedules for a specific query:
GET /GetUserScheduleList?queryid=query_abc123
(optional)
\n","type":"text/plain"},"key":"queryid","value":"query_abc123def456"}],"variable":[]}},"response":[{"id":"ad94462e-61b5-44ee-a46e-e1dc410daa36","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://instadb.ai/api/GetUserScheduleList?queryid=query_abc123def456","protocol":"https","host":["instadb","ai"],"path":["api","GetUserScheduleList"],"query":[{"key":"queryid","value":"query_abc123def456","description":"(optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Thu, 16 Oct 2025 03:58:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"instantjsonsresult\": \"{\\\"columns\\\":[{\\\"name\\\":\\\"id\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"queryid\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"email\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"json\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"enddate\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"lastrun\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"lastupdated\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"nextrun\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"active\\\",\\\"type\\\":\\\"boolean\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"createdon\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"cronexpression\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"startdate\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"userid\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"}],\\\"rows\\\":[[\\\"f1880ee5-fb79-4c8c-b870-debdd9cb8d84\\\",\\\"query_abc123def456\\\",\\\"elijahrienks3@gmail.com\\\",\\\"{\\\\u0022exportFormat\\\\u0022:\\\\u0022csv\\\\u0022}\\\",null,null,\\\"2025-10-15T23:57:30-04:00\\\",null,true,\\\"2025-10-15T23:57:30-04:00\\\",\\\"0 9 * * *\\\",\\\"2025-10-16T00:00:00-04:00\\\",\\\"e32c2dde-26b7-4eff-bc18-66c7404ceafd\\\"],[\\\"schedule_xyz789\\\",\\\"query_abc123def456\\\",\\\"elijahrienks3@gmail.com\\\",\\\"\\\",\\\"2025-12-31T23:59:59-05:00\\\",null,\\\"2025-10-15T23:57:53-04:00\\\",null,true,null,\\\"0 6 * * *\\\",\\\"2025-10-16T00:00:00-04:00\\\",\\\"e32c2dde-26b7-4eff-bc18-66c7404ceafd\\\"]],\\\"cursor\\\":null}\",\n \"instantobjectresult\": null,\n \"success\": true,\n \"timespan\": 15,\n \"message\": null,\n \"recordcount\": 2,\n \"totalrecordcount\": 0,\n \"cursorid\": null,\n \"hasmorerecord\": null\n}"}],"_postman_id":"5988b85f-0d08-4891-8329-7cad1a21e95c"}],"id":"dfc7cde4-eb2a-441c-b6a7-330cbf1034aa","_postman_id":"dfc7cde4-eb2a-441c-b6a7-330cbf1034aa","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetUserQueryList endpoint provides a comprehensive listing of all saved queries belonging to the authenticated user, including detailed metadata and execution history.
\nParameters
\n- queryid (String, query parameter, optional): Filter results to a specific query by its identifier.
\nResponse
\nThe response returns a JSON object with query list data in structured format including query metadata, version information, and last execution timestamps.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(optional)
\n","type":"text/plain"},"key":"queryid","value":"query_abc123def456"}],"variable":[]}},"response":[{"id":"f90b2127-3f2e-4ab5-bebf-809bb8d37f76","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"}],"url":{"raw":"https://instadb.ai/api/GetUserQueryList?queryid=query_abc123def456","protocol":"https","host":["instadb","ai"],"path":["api","GetUserQueryList"],"query":[{"key":"queryid","value":"query_abc123def456","description":"(optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Date","value":"Thu, 16 Oct 2025 03:58:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"instantjsonsresult\": \"{\\\"columns\\\":[{\\\"name\\\":\\\"createdon\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"email\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"id\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"indexname\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"lastupdated\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"querydesc\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"queryjson\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"queryname\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"querysql\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"savetable\\\",\\\"type\\\":\\\"Int32\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"userid\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"version_id\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"b.id\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"b.email\\\",\\\"type\\\":\\\"text\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"},{\\\"name\\\":\\\"b.version_id\\\",\\\"type\\\":\\\"date\\\",\\\"group\\\":null,\\\"groupsortno\\\":0,\\\"friendlyname\\\":null,\\\"sortno\\\":0,\\\"istolower\\\":true,\\\"isarray\\\":false,\\\"isarrayflags\\\":[],\\\"ismap\\\":false,\\\"mapkeytype\\\":\\\"\\\",\\\"originaltype\\\":\\\"\\\"}],\\\"rows\\\":[],\\\"cursor\\\":null}\",\n \"instantobjectresult\": null,\n \"success\": true,\n \"timespan\": 48,\n \"message\": null,\n \"recordcount\": 0,\n \"totalrecordcount\": 0,\n \"cursorid\": null,\n \"hasmorerecord\": null\n}"}],"_postman_id":"94ad85a5-f7bd-48ef-adcc-628787e5cefb"}],"id":"6773d10d-98cc-409e-8c62-95db8e3d3c67","_postman_id":"6773d10d-98cc-409e-8c62-95db8e3d3c67","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetUserSavedFileList endpoint retrieves a catalog of all files generated from query executions and exports that have been saved to the user's file storage.
\nParameters
\n- queryid (String, query parameter, optional): Filter to show only files associated with a specific query.
\nResponse
\nThe response returns a JSON object or array containing file metadata including file names, sizes, creation timestamps, and download paths.
\nNote: Returns 404 if no saved files exist for the user or the specified query. This is normal if you haven't run any async queries yet.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(optional)
\n","type":"text/plain"},"key":"queryid","value":"queryid"}],"variable":[]}},"response":[{"id":"ebac84cd-9089-4892-aa44-6d818f55f65c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/plain"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Endpoint Description
\nThe DeleteUserTable endpoint permanently removes a user-created custom table and all associated data from the InstaDB system. This endpoint only works with tables created by the authenticated user.
\nParameters
\n- tablename (String, query parameter, required): The name of the user-created table to delete.
\nResponse
\nThe response returns a success indicator or error message.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetUserTable endpoint retrieves detailed information about all custom tables created by the authenticated user through data uploads.
\nThis request does not require a request body.
\nResponse
\nThe response returns a JSON array containing user table metadata including table names, column definitions, data types, record counts, and creation timestamps.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe Txt2Sql endpoint uses artificial intelligence to convert natural language query descriptions into valid SQL statements for InstaDB tables.
\nRequest Body
\nThe request body should be sent in JSON format:
\n- query (String, required): Natural language description of the desired query.
- sql (String, optional): Existing SQL for reference or refinement.
- table_Names (String, required): Comma-separated list of tables the query should target.
Response
\nThe response returns the AI-generated SQL statement along with explanation and confidence scoring.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe GetRunningQueries endpoint provides real-time visibility into all currently executing queries for the authenticated user or across the system for administrators.
\nThis request does not require a request body.
\nResponse
\nThe response returns a JSON array of currently executing queries with detailed execution metrics including query text, elapsed time, estimated completion time, and resource usage.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Endpoint Description
\nThe CancelUserQuery endpoint immediately terminates a currently executing query using its unique query identifier.
\nParameters
\n- query_id (String, query parameter, required): The unique identifier of the query to cancel.
\nResponse
\nThe response returns a success indicator confirming the query was cancelled.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"