Overview

The V4MOS.AI Facebook Ads API allows you to access and manage campaign data, ad sets, and individual ads.

Available EndpointsCopy Anchor Link

• getAccounts/v1/facebook/accountsRetrieve Facebook Ads accounts data including account status, balance, spending information, and configuration details.
• getCampaigns/v1/facebook/ads/campaignsRetrieve Facebook Ads campaigns data with comprehensive performance metrics.
• getAd Sets/v1/facebook/ads/adsetRetrieve Facebook Ads ad sets data with detailed performance metrics.
• getAds/v1/facebook/adsRetrieve Facebook Ads data with comprehensive performance metrics aggregated at the ad level.
• getAds/v1/facebook/ads/adRetrieve detailed Facebook Ad level performance metrics with enhanced quality and ranking indicators.
• getActions/v1/facebook/ads/actionsRetrieve Facebook Ads actions data with detailed conversion and engagement metrics.
• getDemographics/v1/facebook/ads/demographicRetrieve Facebook Ads demographics data with detailed performance metrics segmented by age and gender.
• getPlatforms/v1/facebook/ads/platformRetrieve Facebook Ads platforms data with performance metrics segmented by publisher platform and ad position.
• getRegions/v1/facebook/ads/regionRetrieve Facebook Ads regions data with performance metrics segmented by geographic location.
• getCreatives/v1/facebook/creativesRetrieve Facebook Ads creative assets data including creative configurations, media assets, and creative-level metadata.
• getAd Set Config/v1/facebook/ads/adset-configRetrieve Facebook Ads ad set configuration data including targeting settings, budget configurations, and ad set-level settings.
• getAd Config/v1/facebook/ads/ad-configRetrieve Facebook Ads configuration data at the ad level including ad settings, budget configurations, and ad-level metadata.
• getCampaigns Config/v1/facebook/ads/campaigns-configRetrieve Facebook Ads campaign configuration data including campaign settings, objective, budget configurations, and campaign-level…
• getAd Creatives/v1/facebook/ads/creativesRetrieve Facebook Ad creatives data grouped by ads with comprehensive creative and ad association information.

Hierarchical StructureCopy Anchor Link

Facebook Ads follows a hierarchical structure:

Campaign
├── Ad Set
│   ├── Ad
│   ├── Ad
│   └── Ad
└── Ad Set
    ├── Ad
    └── Ad

AuthenticationCopy Anchor Link

All endpoints require the x-client-id and x-client-secret headers, plus the organizationId query parameter. See Authentication.

Common ParametersCopy Anchor Link

• organizationId - Organization ID (required)
• userId - User ID
• page - Page number (default: 1)
• limit - Limit per page (default: 500, max: 5000)
• orderBy - Field for ordering
• orderDirection - Order direction (ASC/DESC)
• createdStart - Start date for filtering
• createdEnd - End date for filtering

Facebook-Specific FieldsCopy Anchor Link

CampaignsCopy Anchor Link

• campaign_name - Campaign name
• objective - Campaign objective (e.g., CONVERSIONS, REACH, etc.)
• status - Campaign status
• date_start - Start date
• date_stop - End date

Ad SetsCopy Anchor Link

• adset_name - Ad set name
• campaign_id - Parent campaign ID
• status - Ad set status

AdsCopy Anchor Link

• ad_name - Ad name
• adset_id - Parent ad set ID
• campaign_id - Parent campaign ID

Available MetricsCopy Anchor Link

• clicks - Number of clicks
• reach - Reach
• impressions - Number of impressions
• spend - Amount spent

ResponsesCopy Anchor Link

All responses follow the standard format:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}