Ricky logorickyDocs

Get the ads report

GET
/reports/ads

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.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

from?string

First day, YYYY-MM-DD, America/Panama, inclusive. Send it with to; without both, the report covers the last 7 days including today.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to?string

Last day, YYYY-MM-DD, America/Panama, inclusive. A day after today counts as today. The period is at most 366 days.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate

Response Body

Success.

application/json
  1. response
data*

Meta ad spend next to the conversations each ad brought. A conversation comes from an ad when a customer message carries a Meta ad referral (WhatsApp click-to-chat or an Instagram ad); those are America/Panama days. Spend, impressions and clicks are Meta's daily figures for the ad account's own days, so the edges of a period can differ by the time zones' offset.

curl -X GET 'https://getricky.ai/api/v1/reports/ads'
{  "data": {    "period": {      "from": "2026-10-14",      "to": "2026-10-14",      "days": 1,      "granularity": "day",      "time_zone": "America/Panama",      "previous_from": "2026-10-14",      "previous_to": "2026-10-14"    },    "connection": "connected",    "synced_at": "2026-10-14T15:30:00.000Z",    "currency_code": "string",    "totals": {      "spend": 0,      "impressions": 0,      "clicks": 0,      "conversations": 0,      "cost_per_conversation": 0    },    "previous": {      "spend": 0,      "conversations": 0    },    "series": [      {        "slot": "2026-10-14",        "spend": 0,        "conversations": 0      }    ],    "ads": [      {        "ad_id": "120210000000000001",        "ad_name": "string",        "campaign_name": "string",        "headline": "string",        "spend": 0,        "currency_code": "string",        "impressions": 0,        "clicks": 0,        "conversations": 0,        "cost_per_conversation": 0      }    ],    "generated_at": "2026-10-14T15:30:00.000Z"  }}