{"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-analyticsdata/analyticsdata-properties-batch-run-pivot-reports":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_batch_run_pivot_reports","summary":"Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property.","description":"POST /v1beta/{+property}:batchRunPivotReports","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to…"},"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-analyticsdata/analyticsdata-properties-batch-run-reports":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_batch_run_reports","summary":"Returns multiple reports in a batch. All reports must be for the same Google Analytics property.","description":"POST /v1beta/{+property}:batchRunReports","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to…"},"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-analyticsdata/analyticsdata-properties-check-compatibility":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_check_compatibility","summary":"This compatibility method lists dimensions and metrics that can be added to a report request and maintain…","description":"POST /v1beta/{+property}:checkCompatibility","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. To learn more, see [where to find your Property…"},"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-analyticsdata/analyticsdata-properties-audience-exports-get":{"get":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_audience_exports_get","summary":"Gets configuration metadata about a specific audience export. This method can be used to understand an…","description":"GET /v1beta/{+name}","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"name","in":"query","required":true,"description":"Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`","schema":{"type":"string","description":"Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`"}}],"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-analyticsdata/analyticsdata-properties-run-pivot-report":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_run_pivot_report","summary":"Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and…","description":"POST /v1beta/{+property}:runPivotReport","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to…"},"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-analyticsdata/analyticsdata-properties-run-realtime-report":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_run_realtime_report","summary":"Returns a customized report of realtime event data for your property. Events appear in realtime reports…","description":"POST /v1beta/{+property}:runRealtimeReport","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to…"},"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-analyticsdata/analyticsdata-properties-run-report":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_run_report","summary":"Returns a customized report of your Google Analytics event data. Reports contain statistics derived from…","description":"POST /v1beta/{+property}:runReport","tags":["analytics"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["property","body"],"properties":{"property":{"type":"string","description":"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to…"},"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-analyticsdata/analyticsdata-properties-audience-exports-list":{"get":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_audience_exports_list","summary":"Lists all audience exports for a property. This method can be used for you to find and reuse existing…","description":"GET /v1beta/{+parent}/audienceExports","tags":["analytics"],"x-apizie-access":"read","parameters":[{"name":"pageSize","in":"query","required":false,"description":"Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200…","schema":{"type":"integer","description":"Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200…"}},{"name":"pageToken","in":"query","required":false,"description":"Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When…","schema":{"type":"string","description":"Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When…"}},{"name":"parent","in":"query","required":true,"description":"Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`","schema":{"type":"string","description":"Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`"}}],"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-analyticsdata/analyticsdata-properties-audience-exports-create":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_audience_exports_create","summary":"Creates an audience export for later retrieval. This method quickly returns the audience export's resource…","description":"POST /v1beta/{+parent}/audienceExports","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 audience export will be created. Format: `properties/{property}`"},"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-analyticsdata/analyticsdata-properties-audience-exports-query":{"post":{"operationId":"analytics_googleapis_analyticsdata_analyticsdata_properties_audience_exports_query","summary":"Retrieves an audience export of users. After creating an audience, the users are not immediately available…","description":"POST /v1beta/{+name}:query","tags":["analytics"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","body"],"properties":{"name":{"type":"string","description":"Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}`"},"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"}}}}}}}