Ricky logorickyDocs

List Meta ads

GET
/ads/ads

Ads of the connected Meta ad accounts with their creative copy, 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+$
campaign_id?string

Only the ads of this campaign.

Match^\d+$
ad_set_id?string

Only the ads of this ad set.

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/ads'
{  "data": [    {      "id": "string",      "account_id": "string",      "campaign_id": "string",      "ad_set_id": "string",      "name": "string",      "status": "string",      "effective_status": "string",      "creative": {        "id": "string",        "title": "string",        "body": "string",        "call_to_action_type": "string",        "image_url": "string",        "thumbnail_url": "string",        "instagram_permalink_url": "string",        "object_story_spec": null      },      "created_time": "string",      "updated_time": "string"    }  ],  "next_cursor": "string"}

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`.

Get Meta ads insights GET

Spend, delivery and Meta's actions for the connected ad accounts over a period, per account, campaign, ad set or ad, computed live by Meta. Answers `rule_violation` when the organization has not connected Meta Ads, and `forbidden` when Meta no longer accepts its connection. Scope: `reports:read`.