How is my business doing
One read for the owner's usual question: the website, the ads (ready, prepared or live), the money available for ads, leads, and what is blocking the ads (blockers) with where to fix it. Money is USD cents. Report blockers in plain words.
One read for the owner's usual question: the website, the ads (ready, prepared or live), the money available for ads, leads, and what is blocking the ads (blockers) with where to fix it. Money is USD cents. Report blockers in plain words.
Create a scoped key in Benjiads → Integrations. Sent only in Authorization.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/overview"{ "business": { "id": "string", "name": "string", "slug": "string", "trade": "string", "siteUrl": "http://example.com", "setupComplete": true, "siteStatus": "string" }, "ads": { "state": "building", "readyAds": 0, "images": [ "http://example.com" ], "campaigns": [ { "id": "string", "name": "string", "status": "string", "dailyBudgetCents": 0 } ] }, "money": { "availableCents": 0, "fundedCents": 0, "spentCents": 0 }, "leads": { "total": 0, "last7Days": 0 }, "blockers": [ { "code": "string", "message": "string", "url": "http://example.com" } ], "next": "string"}List the owner's businesses GET
Every business this connection can reach. Empty means none is set up yet: offer setup_business. With several, ask which one and pass its id as business_id.
Launch the business's ads POST
Put the business's ready ads on Facebook and Instagram at a daily budget the owner explicitly agreed to (repeat it back first; it is the total across cities). Ads are prepared right away; they start spending only once the ad balance is funded (fund_ads) and the account activation is done, and then go live without another call. Returns the blockers still in the way.