{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:microsoft-fabric-dataflow/items-list-dataflows":{"get":{"operationId":"analytics_microsoft_fabric_dataflow_items_list_dataflows","summary":"Returns a list of Dataflows from the specified workspace.","description":"GET /workspaces/{workspaceId}/dataflows","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-dataflow/items-create-dataflow":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_items_create_dataflow","summary":"Creates a Dataflow in the specified workspace.","description":"POST /workspaces/{workspaceId}/dataflows","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-dataflow/items-get-dataflow":{"get":{"operationId":"analytics_microsoft_fabric_dataflow_items_get_dataflow","summary":"Returns properties of the specified Dataflow.","description":"GET /workspaces/{workspaceId}/dataflows/{dataflowId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"dataflowId","in":"query","required":true,"description":"The Dataflow ID.","schema":{"type":"string","description":"The Dataflow 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-dataflow/items-update-dataflow":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_items_update_dataflow","summary":"Updates the properties of the specified Dataflow.","description":"PATCH /workspaces/{workspaceId}/dataflows/{dataflowId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The Dataflow 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-dataflow/items-delete-dataflow":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_items_delete_dataflow","summary":"Deletes the specified Dataflow.","description":"DELETE /workspaces/{workspaceId}/dataflows/{dataflowId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The Dataflow 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-dataflow/items-get-dataflow-definition":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_items_get_dataflow_definition","summary":"Returns the specified Dataflow public definition.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The Dataflow ID."},"format":{"type":"string","description":"The format of the dataflow 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-dataflow/items-update-dataflow-definition":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_items_update_dataflow_definition","summary":"Overrides the definition for the specified Dataflow.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The Dataflow 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-dataflow/items-discover-dataflow-parameters":{"get":{"operationId":"analytics_microsoft_fabric_dataflow_items_discover_dataflow_parameters","summary":"Retrieves all parameters defined in the specified Dataflow.","description":"GET /workspaces/{workspaceId}/dataflows/{dataflowId}/parameters","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"dataflowId","in":"query","required":true,"description":"The Dataflow ID.","schema":{"type":"string","description":"The Dataflow 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-dataflow/background-jobs-schedule-execute":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_background_jobs_schedule_execute","summary":"Create a new execute schedule for a dataflow. A dataflow can create maximum 20 schedulers.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/execute/schedules","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The item 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-dataflow/background-jobs-schedule-apply-changes":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_background_jobs_schedule_apply_changes","summary":"Create a new apply changes schedule for a dataflow. A dataflow can create maximum 20 schedulers.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/applyChanges/schedules","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The item 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-dataflow/background-jobs-run-on-demand-execute":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_background_jobs_run_on_demand_execute","summary":"Run on-demand execute job instance.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/execute/instances","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The dataflow 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-dataflow/background-jobs-run-on-demand-apply-changes":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_background_jobs_run_on_demand_apply_changes","summary":"Run on-demand apply changes job instance.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/applyChanges/instances","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The dataflow 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/analytics:microsoft-fabric-dataflow/upgrade-list-readiness":{"get":{"operationId":"analytics_microsoft_fabric_dataflow_upgrade_list_readiness","summary":"Lists Gen1 dataflow upgrade readiness results in the specified workspace.","description":"GET /workspaces/{workspaceId}/dataflows/gen1UpgradeReadinessResults","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of results per page. The value must be between 1 and 30. When omitted, the server selects the page size.","schema":{"type":"integer","description":"The maximum number of results per page. The value must be between 1 and 30. When omitted, the server selects the page size."}},{"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-dataflow/upgrade-upgrade-dataflows":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_upgrade_upgrade_dataflows","summary":"Upgrades Gen1 dataflows in the specified workspace.","description":"POST /workspaces/{workspaceId}/dataflows/gen1Upgrade","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-dataflow/query-execution-execute-query":{"post":{"operationId":"analytics_microsoft_fabric_dataflow_query_execution_execute_query","summary":"Executes a query against a dataflow and returns the result.","description":"POST /workspaces/{workspaceId}/dataflows/{dataflowId}/executeQuery","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","dataflowId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"dataflowId":{"type":"string","description":"The Dataflow 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"}}},"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"}}}}}}}