{"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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-list":{"get":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_list","summary":"Lists pipelines. Returns a \"FORBIDDEN\" error if the caller doesn't have permission to access it.","description":"GET /v1/{+parent}/pipelines","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied…","schema":{"type":"string","description":"An expression for filtering the results of the request. If unspecified, all pipelines will be returned. Multiple filters can be applied…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If…","schema":{"type":"integer","description":"The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If…"}},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other…","schema":{"type":"string","description":"A page token, received from a previous `ListPipelines` call. Provide this to retrieve the subsequent page. When paginating, all other…"}},{"name":"parent","in":"query","required":true,"description":"Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`.","schema":{"type":"string","description":"Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-create":{"post":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_create","summary":"Creates a pipeline. For a batch pipeline, you can pass scheduler information. Data Pipelines uses the…","description":"POST /v1/{+parent}/pipelines","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-get":{"get":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_get","summary":"Looks up a single pipeline. Returns a \"NOT_FOUND\" error if no such pipeline exists. Returns a \"FORBIDDEN\"…","description":"GET /v1/{+name}","tags":["analytics"],"parameters":[{"name":"name","in":"query","required":true,"description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.","schema":{"type":"string","description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-patch":{"post":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_patch","summary":"Updates a pipeline. If successful, the updated Pipeline is returned. Returns `NOT_FOUND` if the pipeline…","description":"PATCH /v1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters…"},"updateMask":{"type":"string","description":"The list of fields to be updated."},"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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-delete":{"post":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_delete","summary":"Deletes a pipeline. If a scheduler job is attached to the pipeline, it will be deleted.","description":"DELETE /v1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-run":{"post":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_run","summary":"Creates a job for the specified pipeline directly. You can use this method when the internal scheduler is…","description":"POST /v1/{+name}:run","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-stop":{"post":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_stop","summary":"Freezes pipeline execution permanently. If there's a corresponding scheduler entry, it's deleted, and the…","description":"POST /v1/{+name}:stop","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_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:googleapis-datapipelines/datapipelines-projects-locations-pipelines-jobs-list":{"get":{"operationId":"analytics_googleapis_datapipelines_datapipelines_projects_locations_pipelines_jobs_list","summary":"Lists jobs for a given pipeline. Throws a \"FORBIDDEN\" error if the caller doesn't have permission to access…","description":"GET /v1/{+parent}/jobs","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If…","schema":{"type":"integer","description":"The maximum number of entities to return. The service may return fewer than this value, even if there are additional pages. If…"}},{"name":"pageToken","in":"query","required":false,"description":"A page token, received from a previous `ListJobs` call. Provide this to retrieve the subsequent page. When paginating, all other…","schema":{"type":"string","description":"A page token, received from a previous `ListJobs` call. Provide this to retrieve the subsequent page. When paginating, all other…"}},{"name":"parent","in":"query","required":true,"description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`.","schema":{"type":"string","description":"Required. The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_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"}}},"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"}}}}}}}