{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:microsoft-fabric-eventstream/items-list-eventstreams":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_items_list_eventstreams","summary":"Returns a list of eventstreams from the specified workspace.","description":"GET /workspaces/{workspaceId}/eventstreams","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-eventstream/items-create-eventstream":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_items_create_eventstream","summary":"Creates an eventstream in the specified workspace.","description":"POST /workspaces/{workspaceId}/eventstreams","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-eventstream/items-get-eventstream":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_items_get_eventstream","summary":"Returns properties of the specified eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream 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-eventstream/items-update-eventstream":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_items_update_eventstream","summary":"Updates the properties of the specified eventstream.","description":"PATCH /workspaces/{workspaceId}/eventstreams/{eventstreamId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream 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-eventstream/items-delete-eventstream":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_items_delete_eventstream","summary":"Deletes the specified eventstream.","description":"DELETE /workspaces/{workspaceId}/eventstreams/{eventstreamId}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream 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-eventstream/items-get-eventstream-definition":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_items_get_eventstream_definition","summary":"Returns the specified eventstream public definition.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"format":{"type":"string","description":"The format of the eventstream 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-eventstream/items-update-eventstream-definition":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_items_update_eventstream_definition","summary":"Updates the definition of a specified eventstream. The update overrides the current definition.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/updateDefinition","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"updateMetadata":{"type":"boolean","description":"Whether to update the item's metadata if it is provided in the `.platform` file. True - Update the metadata if it is provided 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-eventstream/topology-get-eventstream-topology":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_topology_get_eventstream_topology","summary":"Returns the topology of the specified eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}/topology","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream 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-eventstream/topology-pause-eventstream":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_pause_eventstream","summary":"Pause running all supported sources and destinations of the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/pause","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream 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-eventstream/topology-resume-eventstream":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_resume_eventstream","summary":"Resume running all supported sources and destinations of the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/resume","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream 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-eventstream/topology-get-eventstream-source":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_topology_get_eventstream_source","summary":"Returns the specified source of the eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream ID."}},{"name":"sourceId","in":"query","required":true,"description":"The source ID.","schema":{"type":"string","description":"The source 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-eventstream/topology-get-eventstream-destination":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_topology_get_eventstream_destination","summary":"Returns the specified destination of the eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream ID."}},{"name":"destinationId","in":"query","required":true,"description":"The destination ID.","schema":{"type":"string","description":"The destination 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-eventstream/topology-get-eventstream-source-connection":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_topology_get_eventstream_source_connection","summary":"Returns the connection information of specified source of the eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/connection","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream ID."}},{"name":"sourceId","in":"query","required":true,"description":"The source ID.","schema":{"type":"string","description":"The source 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-eventstream/topology-get-eventstream-destination-connection":{"get":{"operationId":"analytics_microsoft_fabric_eventstream_topology_get_eventstream_destination_connection","summary":"Returns the connection information of a specified destination of the eventstream.","description":"GET /workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/connection","tags":["analytics"],"parameters":[{"name":"workspaceId","in":"query","required":true,"description":"The workspace ID.","schema":{"type":"string","description":"The workspace ID."}},{"name":"eventstreamId","in":"query","required":true,"description":"The eventstream ID.","schema":{"type":"string","description":"The eventstream ID."}},{"name":"destinationId","in":"query","required":true,"description":"The destination ID.","schema":{"type":"string","description":"The destination 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-eventstream/topology-pause-eventstream-source":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_pause_eventstream_source","summary":"Pause running the specified source in the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/pause","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","sourceId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"sourceId":{"type":"string","description":"The eventstream source 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-eventstream/topology-resume-eventstream-source":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_resume_eventstream_source","summary":"Resume running the specified source in the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/sources/{sourceId}/resume","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","sourceId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"sourceId":{"type":"string","description":"The eventstream source 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-eventstream/topology-pause-eventstream-destination":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_pause_eventstream_destination","summary":"Pause running the specified destination in the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/pause","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","destinationId"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"destinationId":{"type":"string","description":"The eventstream destination 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-eventstream/topology-resume-eventstream-destination":{"post":{"operationId":"analytics_microsoft_fabric_eventstream_topology_resume_eventstream_destination","summary":"Resume running the specified destination in the eventstream.","description":"POST /workspaces/{workspaceId}/eventstreams/{eventstreamId}/destinations/{destinationId}/resume","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","eventstreamId","destinationId","body"],"properties":{"workspaceId":{"type":"string","description":"The workspace ID."},"eventstreamId":{"type":"string","description":"The eventstream ID."},"destinationId":{"type":"string","description":"The eventstream destination 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"}}}}}}}