{"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-forms/forms-forms-batch-update":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_batch_update","summary":"Change the form with a batch of updates.","description":"POST /v1/forms/{formId}:batchUpdate","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formId","body"],"properties":{"formId":{"type":"string","description":"Required. The form 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-forms/forms-forms-create":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_create","summary":"Create a new form using the title given in the provided form message in the request. *Important:* Only the…","description":"POST /v1/forms","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"unpublished":{"type":"boolean","description":"Optional. Whether the form is unpublished. If set to `true`, the form doesn't accept responses. If set to `false` or unset, the form is…"},"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-forms/forms-forms-get":{"get":{"operationId":"analytics_googleapis_forms_forms_forms_get","summary":"Get a form.","description":"GET /v1/forms/{formId}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"formId","in":"query","required":true,"description":"Required. The form ID.","schema":{"type":"string","description":"Required. The form 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-forms/forms-forms-set-publish-settings":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_set_publish_settings","summary":"Updates the publish settings of a form. Legacy forms aren't supported because they don't have the…","description":"POST /v1/forms/{formId}:setPublishSettings","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formId","body"],"properties":{"formId":{"type":"string","description":"Required. The ID of the form. You can get the id from Form.form_id field."},"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-forms/forms-forms-responses-get":{"get":{"operationId":"analytics_googleapis_forms_forms_forms_responses_get","summary":"Get one response from the form.","description":"GET /v1/forms/{formId}/responses/{responseId}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"formId","in":"query","required":true,"description":"Required. The form ID.","schema":{"type":"string","description":"Required. The form ID."}},{"name":"responseId","in":"query","required":true,"description":"Required. The response ID within the form.","schema":{"type":"string","description":"Required. The response ID within the form."}}],"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-forms/forms-forms-responses-list":{"get":{"operationId":"analytics_googleapis_forms_forms_forms_responses_list","summary":"List a form's responses.","description":"GET /v1/forms/{formId}/responses","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"filter","in":"query","required":false,"description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses…","schema":{"type":"string","description":"Which form responses to return. Currently, the only supported filters are: * timestamp > *N* which means to get all form responses…"}},{"name":"formId","in":"query","required":true,"description":"Required. ID of the Form whose responses to list.","schema":{"type":"string","description":"Required. ID of the Form whose responses to list."}},{"name":"pageSize","in":"query","required":false,"description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses…","schema":{"type":"integer","description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses…"}},{"name":"pageToken","in":"query","required":false,"description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the…","schema":{"type":"string","description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the…"}}],"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-forms/forms-forms-watches-list":{"get":{"operationId":"analytics_googleapis_forms_forms_forms_watches_list","summary":"Return a list of the watches owned by the invoking project. The maximum number of watches is two: For each…","description":"GET /v1/forms/{formId}/watches","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"formId","in":"query","required":true,"description":"Required. ID of the Form whose watches to list.","schema":{"type":"string","description":"Required. ID of the Form whose watches to list."}}],"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-forms/forms-forms-watches-create":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_watches_create","summary":"Create a new watch. If a watch ID is provided, it must be unused. For each invoking project, the per form…","description":"POST /v1/forms/{formId}/watches","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formId","body"],"properties":{"formId":{"type":"string","description":"Required. ID of the Form to watch."},"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-forms/forms-forms-watches-delete":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_watches_delete","summary":"Delete a watch.","description":"DELETE /v1/forms/{formId}/watches/{watchId}","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formId","watchId"],"properties":{"formId":{"type":"string","description":"Required. The ID of the Form."},"watchId":{"type":"string","description":"Required. The ID of the Watch to delete."}}}}}},"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-forms/forms-forms-watches-renew":{"post":{"operationId":"analytics_googleapis_forms_forms_forms_watches_renew","summary":"Renew an existing watch for seven days. The state of the watch after renewal is `ACTIVE`, and the…","description":"POST /v1/forms/{formId}/watches/{watchId}:renew","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formId","watchId","body"],"properties":{"formId":{"type":"string","description":"Required. The ID of the Form."},"watchId":{"type":"string","description":"Required. The ID of the Watch to renew."},"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"}}}}}}}