V4MOS.AI API
GuidesAPI Referenceapp.v4mos.ai
Google Ads

Campaigns

GET
/v1/google/ads/campaigns

Retrieve Google Ads campaign data with comprehensive performance metrics.

This endpoint provides campaign-level insights including status, advertising channel type, budget information, and key performance indicators.

Dimensions Available:

  • Campaign resource name, ID, name, status
  • Advertising channel type/subtype
  • Start/end dates, optimization score
  • Budget details
  • Metrics: clicks, impressions, cost, conversions, CTR, CPC, ROAS, impression share, conversion rates

Limitations:

  • Maximum 5000 records per page
  • Supports date filtering via createdStart and createdEnd (YYYY-MM-DD format)
  • Supports sorting via orderBy and orderDirection (ASC/DESC)

Filters:

  • organizationId (required)
  • userId (optional)
  • integrationName (optional)
  • createdStart (optional)
  • createdEnd (optional)

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

userId?string

User identifier (optional)

integrationName?string

Integration name identifier (optional)

createdStart?string

Start date for filtering (optional, YYYY-MM-DD format)

Formatdate
createdEnd?string

End date for filtering (optional, YYYY-MM-DD format)

Formatdate
page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500
orderBy?string

Field to order by (optional)

orderDirection?string

Order direction (optional)

Value in"ASC""DESC"

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/google/ads/campaigns?organizationId=organization_123&createdStart=2024-01-01&createdEnd=2024-12-31"
{  "data": [    {      "campaign_resource_name": "string",      "campaign_status": "string",      "campaign_advertising_channel_type": "string",      "campaign_name": "string",      "campaign_id": "string",      "campaign_start_date": "2019-08-24",      "campaign_end_date": "2019-08-24",      "campaign_optimization_score": 0,      "metrics_clicks": 0,      "metrics_search_budget_lost_impression_share": 0,      "metrics_search_impression_share": 0,      "metrics_search_rank_lost_impression_share": 0,      "metrics_conversions_from_interactions_rate": 0,      "metrics_conversions_value": 0,      "metrics_conversions": 0,      "metrics_cost_micros": 0,      "metrics_cost_per_conversion": 0,      "metrics_ctr": 0,      "metrics_average_cpc": 0,      "metrics_impressions": 0,      "campaign_budget_amount_micros": 0,      "campaign_budget_resource_name": "string",      "metrics_cost": 0,      "metrics_roas": 0,      "campaign_budget_amount": 0,      "campaign_advertising_channel_sub_type": "string",      "campaign_budget_delivery_method": "string",      "segments_date": "2019-08-24",      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Accounts GET

Previous Page

Ad Groups GET

Next Page