{"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-gmailpostmastertools/gmailpostmastertools-domain-stats-batch-query":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domain_stats_batch_query","summary":"Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't…","description":"POST /v2/domainStats:batchQuery","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-gmailpostmastertools/gmailpostmastertools-domains-list":{"get":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_list","summary":"Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of…","description":"GET /v2/domains","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The…","schema":{"type":"integer","description":"Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. The next_page_token value returned from a previous List request, if any.","schema":{"type":"string","description":"Optional. The next_page_token value returned from a previous List request, if any."}}],"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-gmailpostmastertools/gmailpostmastertools-domains-create":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_create","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Adds a domain to the user's account.…","description":"POST /v2/domains","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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-gmailpostmastertools/gmailpostmastertools-domains-users-get":{"get":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_users_get","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Retrieves detailed information about a…","description":"GET /v2/{+name}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The resource name of the user to retrieve. Format: `domains/{domain}/users/{user}`","schema":{"type":"string","description":"Required. The resource name of the user to retrieve. Format: `domains/{domain}/users/{user}`"}}],"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-gmailpostmastertools/gmailpostmastertools-domains-users-patch":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_users_patch","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Updates a user for a domain. Only…","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 user. Format: users/{user} Note: {user} is the user's email address."},"updateMask":{"type":"string","description":"The list of fields to update."},"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-gmailpostmastertools/gmailpostmastertools-domains-users-delete":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_users_delete","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Deletes a user from a domain. Returns…","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 resource name of the user to delete. Format: domains/{domain}/users/{user}"}}}}}},"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-gmailpostmastertools/gmailpostmastertools-domains-verify":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_verify","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Verifies a user's ownership of a…","description":"POST /v2/{+name}:verify","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 domain to verify."},"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-gmailpostmastertools/gmailpostmastertools-domains-domain-stats-query":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_domain_stats_query","summary":"Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates…","description":"POST /v2/{+parent}/domainStats:query","tags":["analytics"],"x-apizie-access":"read","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 stats are queried. Format: domains/{domain}"},"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-gmailpostmastertools/gmailpostmastertools-domains-users-list":{"get":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_users_list","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Lists the users that have access to a…","description":"GET /v2/{+parent}/users","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"Optional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The…","schema":{"type":"integer","description":"Optional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. The next_page_token value returned from a previous List request, if any.","schema":{"type":"string","description":"Optional. The next_page_token value returned from a previous List request, if any."}},{"name":"parent","in":"query","required":true,"description":"Required. The parent resource name for which to list users. Format: `domains/{domain}`","schema":{"type":"string","description":"Required. The parent resource name for which to list users. Format: `domains/{domain}`"}}],"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-gmailpostmastertools/gmailpostmastertools-domains-users-create":{"post":{"operationId":"analytics_googleapis_gmailpostmastertools_gmailpostmastertools_domains_users_create","summary":"[Developer Preview](https://developers.google.com/workspace/preview): Creates a user, who has access to a…","description":"POST /v2/{+parent}/users","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 where this user will be created. Format: domains/{domain}"},"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"}}}}}}}