{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:microsoft-fabric-kql-database/items-list-kqldatabases":{"get":{"operationId":"analytics_microsoft_fabric_kql_database_items_list_kqldatabases","summary":"Returns a list of KQL databases from the specified workspace.","description":"GET /workspaces/{workspaceId}/kqlDatabases","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"recursive","in":"query","required":false,"description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…","schema":{"type":"boolean","description":"Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,…"}},{"name":"rootFolderId","in":"query","required":false,"description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder.","schema":{"type":"string","description":"This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder."}},{"name":"continuationToken","in":"query","required":false,"description":"A token for retrieving the next page of results.","schema":{"type":"string","description":"A token for retrieving the next page of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-create-kqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_items_create_kqldatabase","summary":"Creates a KQL database in the specified workspace.","description":"POST /workspaces/{workspaceId}/kqlDatabases","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-get-kqldatabase":{"get":{"operationId":"analytics_microsoft_fabric_kql_database_items_get_kqldatabase","summary":"Returns properties of the specified KQL database.","description":"GET /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"kqlDatabaseId","in":"query","required":true,"description":"The KQL database ID.","schema":{"type":"string","description":"The KQL database ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-update-kqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_items_update_kqldatabase","summary":"Updates the properties of the specified KQL database.","description":"PATCH /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-delete-kqldatabase":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_items_delete_kqldatabase","summary":"Deletes the specified KQL database.","description":"DELETE /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"hardDelete":{"type":"boolean","description":"Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-get-kqldatabase-definition":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_items_get_kqldatabase_definition","summary":"Returns the specified KQL database public definition.","description":"POST /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"format":{"type":"string","description":"The format of the KQL database public definition."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/items-update-kqldatabase-definition":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_items_update_kqldatabase_definition","summary":"Overrides the definition for the specified KQL database.","description":"POST /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"updateMetadata":{"type":"boolean","description":"When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/table-shortcuts-list-shortcuts":{"get":{"operationId":"analytics_microsoft_fabric_kql_database_table_shortcuts_list_shortcuts","summary":"Returns a list of all table shortcuts under a database.","description":"GET /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"kqlDatabaseId","in":"query","required":true,"description":"The KQL database ID.","schema":{"type":"string","description":"The KQL database ID."}},{"name":"continuationToken","in":"query","required":false,"description":"A token for retrieving the next page of results.","schema":{"type":"string","description":"A token for retrieving the next page of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/table-shortcuts-create-shortcut":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_table_shortcuts_create_shortcut","summary":"Creates a new table shortcut under a database.","description":"POST /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId","body"],"properties":{"workspaceId":{"type":"string","description":"The ID of the workspace."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/table-shortcuts-get-shortcut":{"get":{"operationId":"analytics_microsoft_fabric_kql_database_table_shortcuts_get_shortcut","summary":"Returns the properties of a table shortcut under a database.","description":"GET /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts/{shortcutName}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"kqlDatabaseId","in":"query","required":true,"description":"The KQL database ID.","schema":{"type":"string","description":"The KQL database ID."}},{"name":"shortcutName","in":"query","required":true,"description":"The name of the shortcut","schema":{"type":"string","description":"The name of the shortcut"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-kql-database/table-shortcuts-delete-shortcut":{"post":{"operationId":"analytics_microsoft_fabric_kql_database_table_shortcuts_delete_shortcut","summary":"Deletes a table shortcut under a database.","description":"DELETE /workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts/{shortcutName}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","kqlDatabaseId","shortcutName"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"kqlDatabaseId":{"type":"string","description":"The KQL database ID."},"shortcutName":{"type":"string","description":"The name of the shortcut"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}