{"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:googleapis-bigquerydatatransfer/bigquerydatatransfer-projects-locations-enroll-data-sources":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_locations_enroll_data_sources","summary":"Enroll data sources in a user project. This allows users to create transfer configurations for these data…","description":"POST /v1/{+name}:enrollDataSources","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the project resource in the form: `projects/{project_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-bigquerydatatransfer/bigquerydatatransfer-projects-locations-data-sources-check-v":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_locations_data_sources_check_v","summary":"Returns true if valid credentials exist for the given data source and requesting user.","description":"POST /v1/{+name}:checkValidCreds","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the data source. If you are using the regionless method, the location must be `US` and the name should be 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:googleapis-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-transfer-reso":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_transfer_reso","summary":"Returns a transfer resource.","description":"GET /v1/{+name}","tags":["analytics"],"parameters":[{"name":"name","in":"query","required":true,"description":"Required. The name of the transfer resource in the form of: *…","schema":{"type":"string","description":"Required. The name of the transfer resource in the form of: *…"}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-patch":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_patch","summary":"Updates a data transfer configuration. All fields must be set, even if they are not updated.","description":"PATCH /v1/{+name}","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"authorizationCode":{"type":"string","description":"Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data…"},"name":{"type":"string","description":"Identifier. The resource name of the transfer config. Transfer config names have the form either…"},"serviceAccountName":{"type":"string","description":"Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It…"},"updateMask":{"type":"string","description":"Required. Required list of fields to be updated in this request."},"versionInfo":{"type":"string","description":"Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if…"},"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-runs-delete":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_runs_delete","summary":"Deletes the specified transfer run.","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 name of the resource requested. If you are using the regionless method, the location must be `US` and the name should be in…"}}}}}},"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-bigquerydatatransfer/bigquerydatatransfer-projects-locations-data-sources-list":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_locations_data_sources_list","summary":"Lists supported data sources and returns their settings.","description":"GET /v1/{+parent}/dataSources","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"Page size. The default page size is the maximum value of 1000 results.","schema":{"type":"integer","description":"Page size. The default page size is the maximum value of 1000 results."}},{"name":"pageToken","in":"query","required":false,"description":"Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results,…","schema":{"type":"string","description":"Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results,…"}},{"name":"parent","in":"query","required":true,"description":"Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or…","schema":{"type":"string","description":"Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or…"}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-locations-list":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_locations_list","summary":"Lists information about the supported locations for this service. This method lists locations based on the…","description":"GET /v1/{+name}/locations","tags":["analytics"],"parameters":[{"name":"extraLocationTypes","in":"query","required":false,"description":"Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.","schema":{"type":"string","description":"Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage."}},{"name":"filter","in":"query","required":false,"description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is…","schema":{"type":"string","description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is…"}},{"name":"name","in":"query","required":true,"description":"The resource that owns the locations collection, if applicable.","schema":{"type":"string","description":"The resource that owns the locations collection, if applicable."}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of results to return. If not set, the service selects a default.","schema":{"type":"integer","description":"The maximum number of results to return. If not set, the service selects a default."}},{"name":"pageToken","in":"query","required":false,"description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","schema":{"type":"string","description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page."}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-locations-unenroll-data-source":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_locations_unenroll_data_source","summary":"Unenroll data sources in a user project. This allows users to remove transfer configurations for these data…","description":"POST /v1/{+name}:unenrollDataSources","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the project resource in the form: `projects/{project_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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-list":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_list","summary":"Returns information about all transfer configs owned by a project in the specified location.","description":"GET /v1/{+parent}/transferConfigs","tags":["analytics"],"parameters":[{"name":"dataSourceIds","in":"query","required":false,"description":"When specified, only configurations of requested data sources are returned.","schema":{"type":"string","description":"When specified, only configurations of requested data sources are returned."}},{"name":"pageSize","in":"query","required":false,"description":"Page size. The default page size is the maximum value of 1000 results.","schema":{"type":"integer","description":"Page size. The default page size is the maximum value of 1000 results."}},{"name":"pageToken","in":"query","required":false,"description":"Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results,…","schema":{"type":"string","description":"Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results,…"}},{"name":"parent","in":"query","required":true,"description":"Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must…","schema":{"type":"string","description":"Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must…"}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-create":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_create","summary":"Creates a new data transfer configuration.","description":"POST /v1/{+parent}/transferConfigs","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"authorizationCode":{"type":"string","description":"Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data…"},"parent":{"type":"string","description":"Required. The BigQuery project id where the transfer configuration should be created. Must be in the format…"},"serviceAccountName":{"type":"string","description":"Optional service account email. If this field is set, the transfer config will be created with this service account's credentials. It…"},"versionInfo":{"type":"string","description":"Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if…"},"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-schedule-runs":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_schedule_runs","summary":"Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the…","description":"POST /v1/{+parent}:scheduleRuns","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be 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:googleapis-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-start-manual":{"post":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_start_manual","summary":"Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time…","description":"POST /v1/{+parent}:startManualRuns","tags":["analytics"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. Transfer configuration name. If you are using the regionless method, the location must be `US` and the name should be 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:googleapis-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-runs-list":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_runs_list","summary":"Returns information about running and completed transfer runs.","description":"GET /v1/{+parent}/runs","tags":["analytics"],"parameters":[{"name":"pageSize","in":"query","required":false,"description":"Page size. The default page size is the maximum value of 1000 results.","schema":{"type":"integer","description":"Page size. The default page size is the maximum value of 1000 results."}},{"name":"pageToken","in":"query","required":false,"description":"Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results,…","schema":{"type":"string","description":"Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results,…"}},{"name":"parent","in":"query","required":true,"description":"Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location…","schema":{"type":"string","description":"Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location…"}},{"name":"runAttempt","in":"query","required":false,"description":"Indicates how run attempts are to be pulled.","schema":{"type":"string","enum":["RUN_ATTEMPT_UNSPECIFIED","LATEST"],"description":"Indicates how run attempts are to be pulled."}},{"name":"states","in":"query","required":false,"description":"When specified, only transfer runs with requested states are returned.","schema":{"type":"string","enum":["TRANSFER_STATE_UNSPECIFIED","PENDING","RUNNING","SUCCEEDED","FAILED","CANCELLED"],"description":"When specified, only transfer runs with requested states are returned."}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-runs-transfer":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_runs_transfer","summary":"Returns log messages for the transfer run.","description":"GET /v1/{+parent}/transferLogs","tags":["analytics"],"parameters":[{"name":"messageTypes","in":"query","required":false,"description":"Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.","schema":{"type":"string","enum":["MESSAGE_SEVERITY_UNSPECIFIED","INFO","WARNING","ERROR"],"description":"Message types to return. If not populated - INFO, WARNING and ERROR messages are returned."}},{"name":"pageSize","in":"query","required":false,"description":"Page size. The default page size is the maximum value of 1000 results.","schema":{"type":"integer","description":"Page size. The default page size is the maximum value of 1000 results."}},{"name":"pageToken","in":"query","required":false,"description":"Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results,…","schema":{"type":"string","description":"Pagination token, which can be used to request a specific page of `ListTransferLogsRequest` list results. For multiple-page results,…"}},{"name":"parent","in":"query","required":true,"description":"Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following…","schema":{"type":"string","description":"Required. Transfer run name. If you are using the regionless method, the location must be `US` and the name should be in the following…"}}],"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-bigquerydatatransfer/bigquerydatatransfer-projects-transfer-configs-transfer-reso-2":{"get":{"operationId":"analytics_googleapis_bigquerydatatransfer_bigquerydatatransfer_projects_transfer_configs_transfer_reso_2","summary":"Returns information about transfer resources.","description":"GET /v1/{+parent}/transferResources","tags":["analytics"],"parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource…","schema":{"type":"string","description":"Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The…","schema":{"type":"integer","description":"Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When…","schema":{"type":"string","description":"Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When…"}},{"name":"parent","in":"query","required":true,"description":"Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following…","schema":{"type":"string","description":"Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following…"}}],"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"}}}}}}}