{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-cloudsupport/cloudsupport-case-classifications-search":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_case_classifications_search","summary":"Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each…","description":"GET /v2/caseClassifications:search","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of classifications fetched with each request.","schema":{"type":"integer","description":"The maximum number of classifications fetched with each request."}},{"name":"pageToken","in":"query","required":false,"description":"A token identifying the page of results to return. If unspecified, the first page is retrieved.","schema":{"type":"string","description":"A token identifying the page of results to return. If unspecified, the first page is retrieved."}},{"name":"query","in":"query","required":false,"description":"An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications…","schema":{"type":"string","description":"An expression used to filter case classifications. If it's an empty string, then no filtering happens. Otherwise, case classifications…"}}],"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-cloudsupport/cloudsupport-cases-close":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_close","summary":"Close a case. EXAMPLES: cURL: ```shell case=\"projects/some-project/cases/43595344\" curl \\ --request POST \\…","description":"POST /v2/{+name}:close","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the case to close."},"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-cloudsupport/cloudsupport-cases-list":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_list","summary":"Retrieve all cases under a parent, but not its children. For example, listing cases under an organization…","description":"GET /v2/{+parent}/cases","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"filter","in":"query","required":false,"description":"An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that…","schema":{"type":"string","description":"An expression used to filter cases. If it's an empty string, then no filtering happens. Otherwise, the endpoint returns the cases that…"}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of cases fetched with each request. Defaults to 10.","schema":{"type":"integer","description":"The maximum number of cases fetched with each request. Defaults to 10."}},{"name":"pageToken","in":"query","required":false,"description":"A token identifying the page of results to return. If unspecified, the first page is retrieved.","schema":{"type":"string","description":"A token identifying the page of results to return. If unspecified, the first page is retrieved."}},{"name":"parent","in":"query","required":true,"description":"Required. The name of a parent to list cases under.","schema":{"type":"string","description":"Required. The name of a parent to list cases under."}}],"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-cloudsupport/cloudsupport-cases-create":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_create","summary":"Create a new case and associate it with a parent. It must have the following fields set: `display_name`,…","description":"POST /v2/{+parent}/cases","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the parent under which the case should be created."},"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-cloudsupport/cloudsupport-cases-escalate":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_escalate","summary":"Escalate a case, starting the Google Cloud Support escalation management process. This operation is only…","description":"POST /v2/{+name}:escalate","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the case to be escalated."},"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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-get":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_get","summary":"Gets a support event subscription. EXAMPLES: cURL: ```shell…","description":"GET /v2/{+name}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The name of the support event subscription to retrieve. Format:…","schema":{"type":"string","description":"Required. The name of the support event subscription to retrieve. Format:…"}}],"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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-patch":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_patch","summary":"Updates a support event subscription. EXAMPLES: cURL: ```shell…","description":"PATCH /v2/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Identifier. The resource name of the support event subscription."},"updateMask":{"type":"string","description":"Optional. The list of fields to update. The only supported value is pub_sub_topic."},"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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-delet":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_delet","summary":"Soft deletes a support event subscription. EXAMPLES: cURL: ```shell…","description":"DELETE /v2/{+name}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Required. The name of the support event subscription to delete. Format:…"}}}}}},"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-cloudsupport/cloudsupport-cases-search":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_search","summary":"Search for cases using a query. EXAMPLES: cURL: ```shell parent=\"projects/some-project\" curl \\ --header…","description":"GET /v2/{+parent}/cases:search","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of cases fetched with each request. The default page size is 10.","schema":{"type":"integer","description":"The maximum number of cases fetched with each request. The default page size is 10."}},{"name":"pageToken","in":"query","required":false,"description":"A token identifying the page of results to return. If unspecified, the first page is retrieved.","schema":{"type":"string","description":"A token identifying the page of results to return. If unspecified, the first page is retrieved."}},{"name":"parent","in":"query","required":true,"description":"The name of the parent resource to search for cases under.","schema":{"type":"string","description":"The name of the parent resource to search for cases under."}},{"name":"query","in":"query","required":false,"description":"An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be…","schema":{"type":"string","description":"An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be…"}}],"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-cloudsupport/cloudsupport-cases-attachments-list":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_attachments_list","summary":"List all the attachments associated with a support case. EXAMPLES: cURL: ```shell…","description":"GET /v2/{+parent}/attachments","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be…","schema":{"type":"integer","description":"The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be…"}},{"name":"pageToken","in":"query","required":false,"description":"A token identifying the page of results to return. If unspecified, the first page is retrieved.","schema":{"type":"string","description":"A token identifying the page of results to return. If unspecified, the first page is retrieved."}},{"name":"parent","in":"query","required":true,"description":"Required. The name of the case for which attachments should be listed.","schema":{"type":"string","description":"Required. The name of the case for which attachments should be listed."}}],"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-cloudsupport/cloudsupport-media-upload":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_media_upload","summary":"Create a file attachment on a case or Cloud resource. The attachment must have the following fields set:…","description":"POST /v2/{+parent}/attachments","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the case or Cloud resource to which the attachment should be attached."},"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-cloudsupport/cloudsupport-cases-comments-list":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_comments_list","summary":"List all the comments associated with a case. EXAMPLES: cURL: ```shell…","description":"GET /v2/{+parent}/comments","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"The maximum number of comments to fetch. Defaults to 10.","schema":{"type":"integer","description":"The maximum number of comments to fetch. Defaults to 10."}},{"name":"pageToken","in":"query","required":false,"description":"A token identifying the page of results to return. If unspecified, the first page is returned.","schema":{"type":"string","description":"A token identifying the page of results to return. If unspecified, the first page is returned."}},{"name":"parent","in":"query","required":true,"description":"Required. The name of the case for which to list comments.","schema":{"type":"string","description":"Required. The name of the case for which to list comments."}}],"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-cloudsupport/cloudsupport-cases-comments-create":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_cases_comments_create","summary":"Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL:…","description":"POST /v2/{+parent}/comments","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The name of the case to which the comment should be added."},"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-cloudsupport/cloudsupport-media-download":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_media_download","summary":"Download a file attached to a case. When this endpoint is called, no \"response body\" will be returned.…","description":"GET /v2/{+name}:download","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"The name of the file attachment to download.","schema":{"type":"string","description":"The name of the file attachment to download."}}],"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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-list":{"get":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_list","summary":"Lists support event subscriptions. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --header…","description":"GET /v2/{+parent}/supportEventSubscriptions","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"filter","in":"query","required":false,"description":"Optional. Filter expression based on AIP-160. Supported fields: - pub_sub_topic - state Examples: -…","schema":{"type":"string","description":"Optional. Filter expression based on AIP-160. Supported fields: - pub_sub_topic - state Examples: -…"}},{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of support event subscriptions to return.","schema":{"type":"integer","description":"Optional. The maximum number of support event subscriptions to return."}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A token identifying the page of results to return. If unspecified, the first page is retrieved. When paginating, all other…","schema":{"type":"string","description":"Optional. A token identifying the page of results to return. If unspecified, the first page is retrieved. When paginating, all other…"}},{"name":"parent","in":"query","required":true,"description":"Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}","schema":{"type":"string","description":"Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id}"}},{"name":"showDeleted","in":"query","required":false,"description":"Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not returned.","schema":{"type":"boolean","description":"Optional. Whether to show deleted subscriptions. By default, deleted subscriptions are not 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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-creat":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_creat","summary":"Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell…","description":"POST /v2/{+parent}/supportEventSubscriptions","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["parent","body"],"properties":{"parent":{"type":"string","description":"Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-expun":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_expun","summary":"Expunges a support event subscription. EXAMPLES: cURL: ```shell…","description":"POST /v2/{+name}:expunge","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the support event subscription to expunge. Format:…"},"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-cloudsupport/cloudsupport-organizations-support-event-subscriptions-undel":{"post":{"operationId":"analytics_googleapis_cloudsupport_cloudsupport_organizations_support_event_subscriptions_undel","summary":"Undeletes a support event subscription. EXAMPLES: cURL: ```shell…","description":"POST /v2/{+name}:undelete","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the support event subscription to undelete. Format:…"},"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":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"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"}}}}}}}