{"openapi":"3.1.0","info":{"title":"GET /api/v1/meta-ads/performance","version":"1.0.0","description":"Read attribution-aware Meta performance"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/meta-ads/performance":{"get":{"tags":["meta-ads"],"summary":"Read attribution-aware Meta performance","description":"Cached campaign/ad-set/ad conversions and value for exactly one action type, split by account, currency and attribution cohort. ROAS is conversion value divided by spend; missing legacy metrics stay unavailable. Does not sum reach or overlapping event types.","operationId":"meta_ads_get_performance","parameters":[{"name":"since","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Since"}},{"name":"until","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Until"}},{"name":"level","in":"query","required":false,"schema":{"enum":["campaign","adset","ad"],"type":"string","default":"campaign","title":"Level"}},{"name":"action_type","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"default":"omni_purchase","title":"Action Type"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_MetaAdsPerformanceResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"meta_ads_get_performance_api_v1_meta_ads_performance_get"}}},"components":{"schemas":{"MetaAdsPerformanceResponse":{"properties":{"since":{"type":"string","format":"date","title":"Since"},"until":{"type":"string","format":"date","title":"Until"},"level":{"type":"string","enum":["campaign","adset","ad"],"title":"Level"},"action_type":{"type":"string","title":"Action Type"},"rows":{"items":{"$ref":"#/components/schemas/MetaAdsPerformanceRow"},"type":"array","title":"Rows"},"unavailable_rows":{"type":"integer","title":"Unavailable Rows","default":0},"complete":{"type":"boolean","title":"Complete"}},"type":"object","required":["since","until","level","action_type","rows","complete"],"title":"MetaAdsPerformanceResponse"},"MetaAdsPerformanceRow":{"properties":{"ad_account_id":{"type":"string","title":"Ad Account Id"},"campaign_id":{"type":"string","title":"Campaign Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"adset_id":{"type":"string","title":"Adset Id","default":""},"ad_id":{"type":"string","title":"Ad Id","default":""},"currency":{"type":"string","title":"Currency"},"spend_minor":{"type":"integer","title":"Spend Minor"},"conversions":{"type":"number","title":"Conversions"},"conversion_value_minor":{"type":"integer","title":"Conversion Value Minor"},"roas":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Roas"},"attribution_windows":{"items":{"type":"string"},"type":"array","title":"Attribution Windows"},"action_report_time":{"type":"string","title":"Action Report Time","default":"impression"}},"type":"object","required":["ad_account_id","campaign_id","currency","spend_minor","conversions","conversion_value_minor","roas","attribution_windows"],"title":"MetaAdsPerformanceRow"},"SuccessEnvelope_MetaAdsPerformanceResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/MetaAdsPerformanceResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MetaAdsPerformanceResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}