Ricky logorickyDocs

List Meta ad campaigns

GET
/ads/campaigns

Campaigns of the connected Meta ad accounts, read live from Meta. Answers rule_violation when the organization has not connected Meta Ads, and forbidden when Meta no longer accepts its connection.

Scope: reports:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Query Parameters

account_id?string

Only this connected ad account.

Match^\d+$
active_only?string

true returns only what Meta is delivering now (effective status ACTIVE).

Default"false"
Value in"true""false"

Response Body

Success.

application/json
  1. response
data*array<>
next_cursor*|

Pass as cursor for the next page; null on the last page.

curl -X GET 'https://getricky.ai/api/v1/ads/campaigns'
{  "data": [    {      "id": "string",      "account_id": "string",      "name": "string",      "objective": "string",      "status": "string",      "effective_status": "string",      "buying_type": "string",      "bid_strategy": "string",      "budget": {        "daily": 0,        "lifetime": 0,        "remaining": 0      },      "start_time": "string",      "stop_time": "string",      "created_time": "string",      "updated_time": "string"    }  ],  "next_cursor": "string"}

Get the ads report GET

Meta ad spend and the conversations each ad brought in the period. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length. Scope: `reports:read`.

List Meta ad sets GET

Ad sets of the connected Meta ad accounts with budget and targeting, read live from Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection. Scope: `reports:read`.