Skip to main content
GET
/
api
/
v1
/
google-ads
/
campaigns
Get Google Ads Campaigns
curl --request GET \
  --url http://localhost:8000/api/v1/google-ads/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "channel_type": "<string>",
      "start_date": "<string>",
      "end_date": "<string>",
      "budget": 123,
      "metrics": {
        "impressions": 123,
        "clicks": 123,
        "ctr": 123,
        "average_cost_per_conv": 123,
        "cost": 123,
        "conversions": 123,
        "conversion_rate": 123,
        "cost_per_conversion": 123,
        "impression_share": 123,
        "abs_top_page_rate": 123
      }
    }
  ],
  "source": "google_ads_api",
  "storage_result": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

customer_id
integer
required
login_customer_id
integer | null
start_date
string
end_date
string
force_refresh
boolean
default:false
token_id
integer | null

Response

Successful Response

The schema for a response of Google Ads campaigns.

campaigns
GoogleAdsCampaignSchema · object[]
required
source
enum<string>
required

The data sources for the Google Ads API.

Available options:
google_ads_api,
mongodb
storage_result
string | null