curl "https://api.orwel.io/api/v1/campaigns?days=30&limit=10" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const res = await fetch('https://api.orwel.io/api/v1/campaigns?days=30', {
headers: { Authorization: `Bearer ${process.env.ORWEL_API_KEY}` }
})
const { data } = await res.json()
{
"data": [
{
"id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f4b1e7c30",
"name": "Search, brand terms",
"status": "enabled",
"platform": "google_ads",
"campaign_type": "SEARCH",
"budget_amount": 50,
"currency": "USD",
"start_date": "2026-09-01",
"end_date": null,
"has_live_traffic": true,
"last_traffic_at": "2026-11-03T18:22:10Z",
"created_at": "2026-09-01T12:00:00Z",
"metrics": {
"days": 30,
"impressions": 18450,
"clicks": 612,
"cost": 1384.2,
"conversions": 41,
"ctr": 3.32
}
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 4
}
}
Campaigns
List Campaigns
Ad campaigns of your workspace (Google Ads, Meta Ads) with impressions, clicks, cost, conversions and CTR over the last days.
GET
/
api
/
v1
/
campaigns
curl "https://api.orwel.io/api/v1/campaigns?days=30&limit=10" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const res = await fetch('https://api.orwel.io/api/v1/campaigns?days=30', {
headers: { Authorization: `Bearer ${process.env.ORWEL_API_KEY}` }
})
const { data } = await res.json()
{
"data": [
{
"id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f4b1e7c30",
"name": "Search, brand terms",
"status": "enabled",
"platform": "google_ads",
"campaign_type": "SEARCH",
"budget_amount": 50,
"currency": "USD",
"start_date": "2026-09-01",
"end_date": null,
"has_live_traffic": true,
"last_traffic_at": "2026-11-03T18:22:10Z",
"created_at": "2026-09-01T12:00:00Z",
"metrics": {
"days": 30,
"impressions": 18450,
"clicks": 612,
"cost": 1384.2,
"conversions": 41,
"ctr": 3.32
}
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 4
}
}
Requires an API key (
orwel_sk_) with the campaigns:read scope.days.
Query Parameters
integer
default:"50"
Maximum number of results to return (max: 100)
integer
default:"0"
Number of results to skip for pagination
integer
default:"30"
Window for the metrics totals, counted back from today (1 to 365)
string
Filter by campaign status, as reported by the ad platform (for example
active, enabled or paused)string
Filter by ad platform,
google_ads or meta_adsResponse
array
Array of campaign objects
Show Campaign Object
Show Campaign Object
string
Unique identifier for the campaign
string
Campaign name in the ad platform
string
Campaign status
string
Ad platform the campaign belongs to
string
Campaign type reported by the platform (for example search or display)
number
Campaign budget, in
currencystring
Currency of the ad account
string
Start date
string
End date, when the campaign has one
boolean
Whether Orwel saw visits from this campaign recently
string
ISO 8601 timestamp of the last visit Orwel attributed to this campaign
object
Totals over the last
days days: days, impressions, clicks, cost, conversions and ctr (percentage)object
Pagination information
curl "https://api.orwel.io/api/v1/campaigns?days=30&limit=10" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const res = await fetch('https://api.orwel.io/api/v1/campaigns?days=30', {
headers: { Authorization: `Bearer ${process.env.ORWEL_API_KEY}` }
})
const { data } = await res.json()
{
"data": [
{
"id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f4b1e7c30",
"name": "Search, brand terms",
"status": "enabled",
"platform": "google_ads",
"campaign_type": "SEARCH",
"budget_amount": 50,
"currency": "USD",
"start_date": "2026-09-01",
"end_date": null,
"has_live_traffic": true,
"last_traffic_at": "2026-11-03T18:22:10Z",
"created_at": "2026-09-01T12:00:00Z",
"metrics": {
"days": 30,
"impressions": 18450,
"clicks": 612,
"cost": 1384.2,
"conversions": 41,
"ctr": 3.32
}
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 4
}
}