Skip to main content
GET
/
api
/
v1
/
google-ads-database-data
/
campaigns
Get Campaigns
curl --request GET \
  --url http://localhost:8000/api/v1/google-ads-database-data/campaigns \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "date_added": "2023-11-07T05:31:56Z",
    "date_updated": "2023-11-07T05:31:56Z",
    "google_ads_customer": {
      "id": 123,
      "date_added": "2023-11-07T05:31:56Z",
      "date_updated": "2023-11-07T05:31:56Z",
      "descriptive_name": "<string>",
      "currency_code": "<string>",
      "time_zone": "<string>",
      "status": "<string>",
      "manager": true,
      "is_active": true,
      "is_deleted": false
    },
    "name": "<string>",
    "status": "<string>",
    "start_date": "2023-12-25",
    "is_active": true,
    "is_deleted": false,
    "channel_type": "<string>",
    "end_date": "2023-12-25"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer
default:100

Maximum number of items to retrieve

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
​
customer_id
integer
required

The Google Ads customer ID

Response

Successful Response

​
id
integer
required

The campaign ID

​
date_added
string<date-time>
required
​
date_updated
string<date-time>
required
​
google_ads_customer
GoogleAdsCustomerSchema · object
required

The Google Ads customer

​
name
string
required

The campaign name

​
status
string
required

The campaign status

​
start_date
string<date>
required

The campaign start date

​
is_active
boolean
default:true
​
is_deleted
boolean
default:false
​
channel_type
string | null

The channel type

​
end_date
string<date> | null

The campaign end date