{"openapi":"3.1.0","info":{"title":"GET /api/v1/meta-ads/spend","version":"1.0.0","description":"Meta ad spend"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/meta-ads/spend":{"get":{"tags":["meta-ads"],"summary":"Meta ad spend","description":"Spend between two dates (inclusive), grouped by day, ad account or campaign. Amounts are in each account currency's minor unit and are never summed across currencies.","operationId":"meta_ads_spend","parameters":[{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First day, YYYY-MM-DD (default: 30 days ago)","title":"Since"},"description":"First day, YYYY-MM-DD (default: 30 days ago)"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Last day, YYYY-MM-DD (default: today)","title":"Until"},"description":"Last day, YYYY-MM-DD (default: today)"},{"name":"group_by","in":"query","required":false,"schema":{"enum":["day","account","campaign"],"type":"string","default":"account","title":"Group By"}},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Restrict to these ad account ids (DayZero ids)","title":"Account Id"},"description":"Restrict to these ad account ids (DayZero ids)"},{"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_MetaAdsSpendResponse_"}}}},"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_spend_api_v1_meta_ads_spend_get"}}},"components":{"schemas":{"MetaAdsCurrencyTotal":{"properties":{"currency":{"type":"string","title":"Currency"},"spend_minor":{"type":"integer","title":"Spend Minor","description":"Spend in the currency's minor unit"}},"additionalProperties":true,"type":"object","required":["currency","spend_minor"],"title":"MetaAdsCurrencyTotal"},"MetaAdsSpendResponse":{"properties":{"since":{"type":"string","format":"date","title":"Since"},"until":{"type":"string","format":"date","title":"Until"},"group_by":{"type":"string","enum":["day","account","campaign"],"title":"Group By"},"rows":{"items":{"$ref":"#/components/schemas/MetaAdsSpendRow"},"type":"array","title":"Rows"},"totals":{"items":{"$ref":"#/components/schemas/MetaAdsCurrencyTotal"},"type":"array","title":"Totals","description":"One total per currency, never mixed"}},"additionalProperties":true,"type":"object","required":["since","until","group_by"],"title":"MetaAdsSpendResponse"},"MetaAdsSpendRow":{"properties":{"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"ad_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ad Account Id"},"meta_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Meta Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"campaign_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Campaign Id"},"campaign_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Campaign Name"},"currency":{"type":"string","title":"Currency"},"spend_minor":{"type":"integer","title":"Spend Minor"},"impressions":{"type":"integer","title":"Impressions","default":0},"clicks":{"type":"integer","title":"Clicks","default":0}},"additionalProperties":true,"type":"object","required":["currency","spend_minor"],"title":"MetaAdsSpendRow"},"SuccessEnvelope_MetaAdsSpendResponse_":{"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/MetaAdsSpendResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MetaAdsSpendResponse]"},"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":[]}]}