> ## Documentation Index
> Fetch the complete documentation index at: https://www.orwel.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Campaigns

> Ad campaigns of your workspace (Google Ads, Meta Ads) with impressions, clicks, cost, conversions and CTR over the last days.

> [!NOTE]
>
> Requires an [API key](https://www.orwel.io/docs/authentication.md) (`orwel_sk_`) with the `campaigns:read` scope.

Campaigns come from the ad accounts connected in **Integrations** ([Google Ads](https://www.orwel.io/docs/integrations/google-ads.md), [Meta Ads](https://www.orwel.io/docs/integrations/meta-ads.md)). Each campaign carries the totals of its daily metrics over the window you choose with `days`.

## Query Parameters

**limit** `integer` (default: 50)

Maximum number of results to return (max: 100)

**offset** `integer` (default: 0)

Number of results to skip for pagination

**days** `integer` (default: 30)

Window for the metrics totals, counted back from today (1 to 365)

**status** `string`

Filter by campaign status, as reported by the ad platform (for example `active`, `enabled` or `paused`)

**platform** `string`

Filter by ad platform, `google_ads` or `meta_ads`

## Response

**data** `array`

Array of campaign objects

**Campaign Object**

**id** `string`

Unique identifier for the campaign

**name** `string`

Campaign name in the ad platform

**status** `string`

Campaign status

**platform** `string`

Ad platform the campaign belongs to

**campaign\_type** `string`

Campaign type reported by the platform (for example search or display)

**budget\_amount** `number`

Campaign budget, in `currency`

**currency** `string`

Currency of the ad account

**start\_date** `string`

Start date

**end\_date** `string`

End date, when the campaign has one

**has\_live\_traffic** `boolean`

Whether Orwel saw visits from this campaign recently

**last\_traffic\_at** `string`

ISO 8601 timestamp of the last visit Orwel attributed to this campaign

**metrics** `object`

Totals over the last `days` days: `days`, `impressions`, `clicks`, `cost`, `conversions` and `ctr` (percentage)

**pagination** `object`

Pagination information

```bash cURL theme={null}
curl "https://api.orwel.io/api/v1/campaigns?days=30&limit=10" \
  -H "Authorization: Bearer orwel_sk_YOUR_KEY"
```

```javascript JavaScript theme={null}
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()
```

```json Response theme={null}
{
  "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
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.