# Ads Manager

> Base URL: `https://pos.pages.fm/api/v1`. Authenticate with the `api_key` query parameter.

## List of ad accounts

`GET /shops/{SHOP_ID}/ads_manager/ad_accounts`

Get list of ad accounts

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `SHOP_ID` | path | integer | yes | Shop ID |
| `page` | query | integer |  | Page number |
| `page_size` | query | integer |  | Number of records per page |

### Responses

- `200` Success (AdAccount)

```json
{
  "success": true,
  "data": [
    {
      "id": "786374497414442",
      "name": "Jen Nhung",
      "account_status": 1,
      "currency": "VND",
      "is_business": false,
      "sync_succeed_at": "2026-05-21T02:00:10",
      "tags": [
        "thẻ 2"
      ]
    }
  ],
  "page_number": 1,
  "page_size": 30,
  "total_entries": 14,
  "total_pages": 1
}
```

## List of ad campaigns

`GET /shops/{SHOP_ID}/ads_manager/campaigns_v2`

Get list of ad campaigns

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `SHOP_ID` | path | integer | yes | Shop ID |
| `page` | query | integer |  | Page number |
| `page_size` | query | integer |  | Number of records per page |
| `start_time` | query | integer (int64) |  | Start of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated from this time. |
| `end_time` | query | integer (int64) |  | End of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated up to this time. |
| `select_fields` | query | string |  | Comma-separated list of additional `insights` fields to include in the response. When specified, only the listed fields are returned inside `insights` (in addition to the always-present base metrics). **Performance** - `ad_performance_session` — Overall performance - `spend` — Amount spent - `reach` — Instant Experience reach - `impressions` — Impressions - `clicks` — Clicks (all) - `frequency` — Frequency - `cpp` — CPP - `cpm` — CPM - `cpc` — CPC - `ctr` — CTR - `cost_per_1000_accounts_center_reach` — Cost per 1000 accounts center reach - `cost_per_result` — Cost per result - `avg_purchase_conversion_value` — Average purchase conversion value - `indicator_result` — Result - `result_roas` — Result ROAS **Engagement** - `ad_engagement_session` — Engagement - `link_click` — Link clicks - `like` — Facebook likes - `comment` — Post comments - `post_engagement` — Post engagements - `post_reaction` — Post reactions - `post` — Post shares - `onsite_conversion_post_save` — Post saves - `photo_view` — Photo views - `video_view` — Video plays (≥3s) - `inline_link_click_ctr` — CTR (link click-through rate) - `outbound_click` — Outbound clicks - `onsite_conversion_messaging_conversation_started_7d` — Messaging conversations started - `onsite_conversion_messaging_first_reply` — New messaging contacts - `onsite_conversion_messaging_block` — Messaging blocks - `video_thruplay_watched_actions` — ThruPlays - `video_play_actions` — Video plays - `video_p25_watched_actions` — Video plays at 25% - `video_p50_watched_actions` — Video plays at 50% - `video_p75_watched_actions` — Video plays at 75% - `video_p95_watched_actions` — Video plays at 95% - `video_p100_watched_actions` — Video plays at 100% - `estimated_ad_recallers` — Estimated ad recall lift (people) - `cost_per_outbound_click` — Cost per outbound click - `cost_per_thruplay` — Cost per ThruPlay - `outbound_clicks_ctr` — Outbound CTR - `cost_per_post_engagement` — Cost per post engagement - `estimated_ad_recall_rate` — Estimated ad recall lift rate - `cost_per_estimated_ad_recallers` — Cost per estimated ad recall lift - `cost_per_messaging_conversation_started` — Cost per messaging conversation started **Conversion** *Leads* - `lead` — Leads - `website_lead` — Website leads - `offline_lead` — Offline leads - `meta_lead` — Meta leads - `lead_conversion_value` — Lead conversion value - `website_lead_conversion_value` — Website lead conversion value - `offline_lead_conversion_value` — Offline lead conversion value - `meta_lead_conversion_value` — Meta lead conversion value - `cost_per_lead` — Cost per lead *Purchases* - `omni_purchase` — Purchases - `inapp_omni_purchase` — In-app purchases - `website_omni_purchase` — Website purchases - `offline_omni_purchase` — Offline purchases - `meta_omni_purchase` — Meta purchases - `omni_purchase_conversion_value` — Purchase conversion value - `inapp_omni_purchase_conversion_value` — In-app purchase conversion value - `website_omni_purchase_conversion_value` — Website purchase conversion value - `offline_omni_purchase_conversion_value` — Offline purchase conversion value - `meta_omni_purchase_conversion_value` — Meta purchase conversion value - `cost_per_omni_purchase` — Cost per purchase *Checkout initiated* - `omni_initiated_checkout` — Checkout initiated - `inapp_omni_initiated_checkout` — In-app checkout initiated - `website_omni_initiated_checkout` — Website checkout initiated - `offline_omni_initiated_checkout` — Offline checkout initiated - `meta_omni_initiated_checkout` — Meta checkout initiated - `omni_initiated_checkout_conversion_value` — Checkout initiation conversion value - `inapp_omni_initiated_checkout_conversion_value` — In-app checkout initiation conversion value - `website_omni_initiated_checkout_conversion_value` — Website checkout initiation conversion value - `offline_omni_initiated_checkout_conversion_value` — Offline checkout initiation conversion value - `meta_omni_initiated_checkout_conversion_value` — Meta checkout initiation conversion value - `cost_per_omni_initiated_checkout` — Cost per checkout initiated *Registrations completed* - `omni_complete_registration` — Registrations completed - `inapp_omni_complete_registration` — In-app registrations completed - `website_omni_complete_registration` — Website registrations completed - `offline_omni_complete_registration` — Offline registrations completed - `omni_complete_registration_conversion_value` — Registration completion conversion value - `inapp_omni_complete_registration_conversion_value` — In-app registration completion conversion value - `website_omni_complete_registration_conversion_value` — Website registration completion conversion value - `offline_omni_complete_registration_conversion_value` — Offline registration completion conversion value - `cost_per_omni_complete_registration` — Cost per registration completed *Content views* - `omni_view_content` — Content views - `inapp_omni_view_content` — In-app content views - `website_omni_view_content` — Website content views - `offline_omni_view_content` — Offline content views - `meta_omni_view_content` — Meta content views - `omni_view_content_conversion_value` — Content view conversion value - `inapp_omni_view_content_conversion_value` — In-app content view conversion value - `website_omni_view_content_conversion_value` — Website content view conversion value - `offline_omni_view_content_conversion_value` — Offline content view conversion value - `meta_omni_view_content_conversion_value` — Meta content view conversion value - `cost_per_omni_view_content` — Cost per content view *Searches* - `omni_search` — Searches - `inapp_omni_search` — In-app searches - `website_omni_search` — Website searches - `offline_omni_search` — Offline searches - `omni_search_conversion_value` — Search conversion value - `inapp_omni_search_conversion_value` — In-app search conversion value - `website_omni_search_conversion_value` — Website search conversion value - `offline_omni_search_conversion_value` — Offline search conversion value - `cost_per_omni_search` — Cost per search *Add to cart* - `omni_add_to_cart` — Add to cart - `inapp_omni_add_to_cart` — In-app add to cart - `website_omni_add_to_cart` — Website add to cart - `offline_omni_add_to_cart` — Offline add to cart - `meta_omni_add_to_cart` — Meta add to cart - `omni_add_to_cart_conversion_value` — Add-to-cart conversion value - `inapp_omni_add_to_cart_conversion_value` — In-app add-to-cart conversion value - `website_omni_add_to_cart_conversion_value` — Website add-to-cart conversion value - `offline_omni_add_to_cart_conversion_value` — Offline add-to-cart conversion value - `meta_omni_add_to_cart_conversion_value` — Meta add-to-cart conversion value - `cost_per_omni_add_to_cart` — Cost per add to cart *Add to wishlist* - `omni_add_to_wishlist` — Add to wishlist - `inapp_omni_add_to_wishlist` — In-app add to wishlist - `website_omni_add_to_wishlist` — Website add to wishlist - `offline_omni_add_to_wishlist` — Offline add to wishlist - `meta_omni_add_to_wishlist` — Meta add to wishlist - `omni_add_to_wishlist_conversion_value` — Add-to-wishlist conversion value - `inapp_omni_add_to_wishlist_conversion_value` — In-app add-to-wishlist conversion value - `website_omni_add_to_wishlist_conversion_value` — Website add-to-wishlist conversion value - `offline_omni_add_to_wishlist_conversion_value` — Offline add-to-wishlist conversion value - `meta_omni_add_to_wishlist_conversion_value` — Meta add-to-wishlist conversion value - `cost_per_omni_add_to_wishlist` — Cost per add to wishlist *Product customizations* - `customize_product_total` — Product customizations - `inapp_customize_product_total` — In-app product customizations - `website_customize_product_total` — Website product customizations - `offline_customize_product_total` — Offline product customizations - `customize_product_total_conversion_value` — Product customization conversion value - `inapp_customize_product_total_conversion_value` — In-app product customization conversion value - `website_customize_product_total_conversion_value` — Website product customization conversion value - `offline_customize_product_total_conversion_value` — Offline product customization conversion value - `cost_per_customize_product_total` — Cost per product customization *Trials started* - `start_trial_total` — Trials started - `inapp_start_trial_total` — In-app trials started - `website_start_trial_total` — Website trials started - `offline_start_trial_total` — Offline trials started - `start_trial_total_conversion_value` — Trial start conversion value - `inapp_start_trial_total_conversion_value` — In-app trial start conversion value - `website_start_trial_total_conversion_value` — Website trial start conversion value - `offline_start_trial_total_conversion_value` — Offline trial start conversion value - `cost_per_start_trial_total` — Cost per trial started *Subscriptions* - `subscribe_total` — Subscriptions - `inapp_subscribe_total` — In-app subscriptions - `website_subscribe_total` — Website subscriptions - `offline_subscribe_total` — Offline subscriptions - `subscribe_total_conversion_value` — Subscription conversion value - `inapp_subscribe_total_conversion_value` — In-app subscription conversion value - `website_subscribe_total_conversion_value` — Website subscription conversion value - `offline_subscribe_total_conversion_value` — Offline subscription conversion value - `cost_per_subscribe_total` — Cost per subscription *Applications submitted* - `submit_application_total` — Applications submitted - `inapp_submit_application_total` — In-app applications submitted - `website_submit_application_total` — Website applications submitted - `offline_submit_application_total` — Offline applications submitted - `meta_submit_application_total` — Meta applications submitted - `submit_application_total_conversion_value` — Application submission conversion value - `inapp_submit_application_total_conversion_value` — In-app application submission conversion value - `website_submit_application_total_conversion_value` — Website application submission conversion value - `offline_submit_application_total_conversion_value` — Offline application submission conversion value - `meta_submit_application_total_conversion_value` — Meta application submission conversion value - `cost_per_submit_application_total` — Cost per application submitted *Contacts* - `contact_total` — Contacts - `inapp_contact_total` — In-app contacts - `website_contact_total` — Website contacts - `offline_contact_total` — Offline contacts - `contact_total_conversion_value` — Contact conversion value - `inapp_contact_total_conversion_value` — In-app contact conversion value - `website_contact_total_conversion_value` — Website contact conversion value - `offline_contact_total_conversion_value` — Offline contact conversion value - `cost_per_contact_total` — Cost per contact *Landing page views* - `landing_page_view` — Landing page views - `inapp_landing_page_view` — In-app landing page views - `website_landing_page_view` — Website landing page views - `cost_per_landing_page_view` — Cost per landing page view *Orders* - `order_created` — Orders created - `order_shipped` — Orders shipped *Purchase ROAS* - `purchase_roas` — Purchase ROAS - `inapp_purchase_roas` — In-app purchase ROAS - `website_purchase_roas` — Website purchase ROAS |

### Responses

- `200` Success (CampaignListResponse)

```json
{
  "success": true,
  "data": [
    {
      "id": "120239433707310738",
      "name": "Chiến dịch Valentine 2026",
      "status": "ACTIVE",
      "effective_status": "ACTIVE",
      "objective": "OUTCOME_TRAFFIC",
      "created_time": "2026-02-02T10:00:29",
      "start_time": "2026-02-02T16:00:00",
      "end_time": "2026-02-03T16:00:00",
      "marketer_id": null,
      "product_id": "8d5e65f5-f1da-42bc-95b4-380f356388a9",
      "product_category_id": null,
      "ad_account": {
        "id": "1427880307614733",
        "name": "Quỳnh Dương",
        "currency": "VND"
      },
      "insights": {
        "ad_ids": [
          "120239433707300738"
        ],
        "impressions": 572,
        "clicks": 14,
        "reach": 512,
        "spend": 59381,
        "cpc": 4241.5,
        "cpm": 103812.937063,
        "cpp": 115978.515625,
        "ctr": 2.44755244755245,
        "frequency": 1.117188,
        "order_statistics": [
          {
            "id": 0,
            "order_count": 0
          },
          {
            "id": 1,
            "order_count": 0
          }
        ]
      }
    }
  ],
  "summary": {
    "impressions": 11462,
    "clicks": 19,
    "reach": 11243,
    "spend": 135140,
    "cpc": 6827.631579,
    "cpm": 11790.263479,
    "cpp": 54927.700908,
    "ctr": 0.165765137,
    "frequency": 1.019478774
  },
  "page_number": 1,
  "page_size": 30,
  "total_entries": 3,
  "total_pages": 1
}
```

## List of ad sets

`GET /shops/{SHOP_ID}/ads_manager/ad_sets_v2`

Get list of ad sets

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `SHOP_ID` | path | integer | yes | Shop ID |
| `page` | query | integer |  | Page number |
| `page_size` | query | integer |  | Number of records per page |
| `start_time` | query | integer (int64) |  | Start of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated from this time. |
| `end_time` | query | integer (int64) |  | End of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated up to this time. |
| `select_fields` | query | string |  | Comma-separated list of additional `insights` fields to include in the response. When specified, only the listed fields are returned inside `insights` (in addition to the always-present base metrics). **Performance** - `ad_performance_session` — Overall performance - `spend` — Amount spent - `reach` — Instant Experience reach - `impressions` — Impressions - `clicks` — Clicks (all) - `frequency` — Frequency - `cpp` — CPP - `cpm` — CPM - `cpc` — CPC - `ctr` — CTR - `cost_per_1000_accounts_center_reach` — Cost per 1000 accounts center reach - `cost_per_result` — Cost per result - `avg_purchase_conversion_value` — Average purchase conversion value - `indicator_result` — Result - `result_roas` — Result ROAS **Engagement** - `ad_engagement_session` — Engagement - `link_click` — Link clicks - `like` — Facebook likes - `comment` — Post comments - `post_engagement` — Post engagements - `post_reaction` — Post reactions - `post` — Post shares - `onsite_conversion_post_save` — Post saves - `photo_view` — Photo views - `video_view` — Video plays (≥3s) - `inline_link_click_ctr` — CTR (link click-through rate) - `outbound_click` — Outbound clicks - `onsite_conversion_messaging_conversation_started_7d` — Messaging conversations started - `onsite_conversion_messaging_first_reply` — New messaging contacts - `onsite_conversion_messaging_block` — Messaging blocks - `video_thruplay_watched_actions` — ThruPlays - `video_play_actions` — Video plays - `video_p25_watched_actions` — Video plays at 25% - `video_p50_watched_actions` — Video plays at 50% - `video_p75_watched_actions` — Video plays at 75% - `video_p95_watched_actions` — Video plays at 95% - `video_p100_watched_actions` — Video plays at 100% - `estimated_ad_recallers` — Estimated ad recall lift (people) - `cost_per_outbound_click` — Cost per outbound click - `cost_per_thruplay` — Cost per ThruPlay - `outbound_clicks_ctr` — Outbound CTR - `cost_per_post_engagement` — Cost per post engagement - `estimated_ad_recall_rate` — Estimated ad recall lift rate - `cost_per_estimated_ad_recallers` — Cost per estimated ad recall lift - `cost_per_messaging_conversation_started` — Cost per messaging conversation started **Conversion** *Leads* - `lead` — Leads - `website_lead` — Website leads - `offline_lead` — Offline leads - `meta_lead` — Meta leads - `lead_conversion_value` — Lead conversion value - `website_lead_conversion_value` — Website lead conversion value - `offline_lead_conversion_value` — Offline lead conversion value - `meta_lead_conversion_value` — Meta lead conversion value - `cost_per_lead` — Cost per lead *Purchases* - `omni_purchase` — Purchases - `inapp_omni_purchase` — In-app purchases - `website_omni_purchase` — Website purchases - `offline_omni_purchase` — Offline purchases - `meta_omni_purchase` — Meta purchases - `omni_purchase_conversion_value` — Purchase conversion value - `inapp_omni_purchase_conversion_value` — In-app purchase conversion value - `website_omni_purchase_conversion_value` — Website purchase conversion value - `offline_omni_purchase_conversion_value` — Offline purchase conversion value - `meta_omni_purchase_conversion_value` — Meta purchase conversion value - `cost_per_omni_purchase` — Cost per purchase *Checkout initiated* - `omni_initiated_checkout` — Checkout initiated - `inapp_omni_initiated_checkout` — In-app checkout initiated - `website_omni_initiated_checkout` — Website checkout initiated - `offline_omni_initiated_checkout` — Offline checkout initiated - `meta_omni_initiated_checkout` — Meta checkout initiated - `omni_initiated_checkout_conversion_value` — Checkout initiation conversion value - `inapp_omni_initiated_checkout_conversion_value` — In-app checkout initiation conversion value - `website_omni_initiated_checkout_conversion_value` — Website checkout initiation conversion value - `offline_omni_initiated_checkout_conversion_value` — Offline checkout initiation conversion value - `meta_omni_initiated_checkout_conversion_value` — Meta checkout initiation conversion value - `cost_per_omni_initiated_checkout` — Cost per checkout initiated *Registrations completed* - `omni_complete_registration` — Registrations completed - `inapp_omni_complete_registration` — In-app registrations completed - `website_omni_complete_registration` — Website registrations completed - `offline_omni_complete_registration` — Offline registrations completed - `omni_complete_registration_conversion_value` — Registration completion conversion value - `inapp_omni_complete_registration_conversion_value` — In-app registration completion conversion value - `website_omni_complete_registration_conversion_value` — Website registration completion conversion value - `offline_omni_complete_registration_conversion_value` — Offline registration completion conversion value - `cost_per_omni_complete_registration` — Cost per registration completed *Content views* - `omni_view_content` — Content views - `inapp_omni_view_content` — In-app content views - `website_omni_view_content` — Website content views - `offline_omni_view_content` — Offline content views - `meta_omni_view_content` — Meta content views - `omni_view_content_conversion_value` — Content view conversion value - `inapp_omni_view_content_conversion_value` — In-app content view conversion value - `website_omni_view_content_conversion_value` — Website content view conversion value - `offline_omni_view_content_conversion_value` — Offline content view conversion value - `meta_omni_view_content_conversion_value` — Meta content view conversion value - `cost_per_omni_view_content` — Cost per content view *Searches* - `omni_search` — Searches - `inapp_omni_search` — In-app searches - `website_omni_search` — Website searches - `offline_omni_search` — Offline searches - `omni_search_conversion_value` — Search conversion value - `inapp_omni_search_conversion_value` — In-app search conversion value - `website_omni_search_conversion_value` — Website search conversion value - `offline_omni_search_conversion_value` — Offline search conversion value - `cost_per_omni_search` — Cost per search *Add to cart* - `omni_add_to_cart` — Add to cart - `inapp_omni_add_to_cart` — In-app add to cart - `website_omni_add_to_cart` — Website add to cart - `offline_omni_add_to_cart` — Offline add to cart - `meta_omni_add_to_cart` — Meta add to cart - `omni_add_to_cart_conversion_value` — Add-to-cart conversion value - `inapp_omni_add_to_cart_conversion_value` — In-app add-to-cart conversion value - `website_omni_add_to_cart_conversion_value` — Website add-to-cart conversion value - `offline_omni_add_to_cart_conversion_value` — Offline add-to-cart conversion value - `meta_omni_add_to_cart_conversion_value` — Meta add-to-cart conversion value - `cost_per_omni_add_to_cart` — Cost per add to cart *Add to wishlist* - `omni_add_to_wishlist` — Add to wishlist - `inapp_omni_add_to_wishlist` — In-app add to wishlist - `website_omni_add_to_wishlist` — Website add to wishlist - `offline_omni_add_to_wishlist` — Offline add to wishlist - `meta_omni_add_to_wishlist` — Meta add to wishlist - `omni_add_to_wishlist_conversion_value` — Add-to-wishlist conversion value - `inapp_omni_add_to_wishlist_conversion_value` — In-app add-to-wishlist conversion value - `website_omni_add_to_wishlist_conversion_value` — Website add-to-wishlist conversion value - `offline_omni_add_to_wishlist_conversion_value` — Offline add-to-wishlist conversion value - `meta_omni_add_to_wishlist_conversion_value` — Meta add-to-wishlist conversion value - `cost_per_omni_add_to_wishlist` — Cost per add to wishlist *Product customizations* - `customize_product_total` — Product customizations - `inapp_customize_product_total` — In-app product customizations - `website_customize_product_total` — Website product customizations - `offline_customize_product_total` — Offline product customizations - `customize_product_total_conversion_value` — Product customization conversion value - `inapp_customize_product_total_conversion_value` — In-app product customization conversion value - `website_customize_product_total_conversion_value` — Website product customization conversion value - `offline_customize_product_total_conversion_value` — Offline product customization conversion value - `cost_per_customize_product_total` — Cost per product customization *Trials started* - `start_trial_total` — Trials started - `inapp_start_trial_total` — In-app trials started - `website_start_trial_total` — Website trials started - `offline_start_trial_total` — Offline trials started - `start_trial_total_conversion_value` — Trial start conversion value - `inapp_start_trial_total_conversion_value` — In-app trial start conversion value - `website_start_trial_total_conversion_value` — Website trial start conversion value - `offline_start_trial_total_conversion_value` — Offline trial start conversion value - `cost_per_start_trial_total` — Cost per trial started *Subscriptions* - `subscribe_total` — Subscriptions - `inapp_subscribe_total` — In-app subscriptions - `website_subscribe_total` — Website subscriptions - `offline_subscribe_total` — Offline subscriptions - `subscribe_total_conversion_value` — Subscription conversion value - `inapp_subscribe_total_conversion_value` — In-app subscription conversion value - `website_subscribe_total_conversion_value` — Website subscription conversion value - `offline_subscribe_total_conversion_value` — Offline subscription conversion value - `cost_per_subscribe_total` — Cost per subscription *Applications submitted* - `submit_application_total` — Applications submitted - `inapp_submit_application_total` — In-app applications submitted - `website_submit_application_total` — Website applications submitted - `offline_submit_application_total` — Offline applications submitted - `meta_submit_application_total` — Meta applications submitted - `submit_application_total_conversion_value` — Application submission conversion value - `inapp_submit_application_total_conversion_value` — In-app application submission conversion value - `website_submit_application_total_conversion_value` — Website application submission conversion value - `offline_submit_application_total_conversion_value` — Offline application submission conversion value - `meta_submit_application_total_conversion_value` — Meta application submission conversion value - `cost_per_submit_application_total` — Cost per application submitted *Contacts* - `contact_total` — Contacts - `inapp_contact_total` — In-app contacts - `website_contact_total` — Website contacts - `offline_contact_total` — Offline contacts - `contact_total_conversion_value` — Contact conversion value - `inapp_contact_total_conversion_value` — In-app contact conversion value - `website_contact_total_conversion_value` — Website contact conversion value - `offline_contact_total_conversion_value` — Offline contact conversion value - `cost_per_contact_total` — Cost per contact *Landing page views* - `landing_page_view` — Landing page views - `inapp_landing_page_view` — In-app landing page views - `website_landing_page_view` — Website landing page views - `cost_per_landing_page_view` — Cost per landing page view *Orders* - `order_created` — Orders created - `order_shipped` — Orders shipped *Purchase ROAS* - `purchase_roas` — Purchase ROAS - `inapp_purchase_roas` — In-app purchase ROAS - `website_purchase_roas` — Website purchase ROAS |

### Responses

- `200` Success (AdSetListResponse)

```json
{
  "success": true,
  "data": [
    {
      "id": "120239433707290738",
      "name": "Nhóm nam giới",
      "status": "ACTIVE",
      "effective_status": "ACTIVE",
      "created_time": "2026-02-02T10:00:30",
      "start_time": "2026-02-02T16:00:00",
      "end_time": "2026-02-03T16:00:00",
      "bid_amount": 0,
      "bid_strategy": null,
      "billing_event": "IMPRESSIONS",
      "daily_budget": 0,
      "lifetime_budget": 0,
      "destination_type": "FACEBOOK_PAGE",
      "optimization_goal": "PROFILE_VISIT",
      "marketer_id": null,
      "product_id": null,
      "product_category_id": null,
      "ad_account": {
        "id": "1427880307614733",
        "name": "Quỳnh Dương",
        "currency": "VND"
      },
      "ad_campaign": {
        "id": "120239433707310738",
        "name": "Chiến dịch Valentine 2026"
      },
      "insights": {
        "ad_ids": [
          "120239433707300738"
        ],
        "impressions": 572,
        "clicks": 14,
        "reach": 512,
        "spend": 59381,
        "cpc": 4241.5,
        "cpm": 103812.937063,
        "cpp": 115978.515625,
        "ctr": 2.44755244755245,
        "frequency": 1.117188
      },
      "targeting": {
        "age_min": 18,
        "age_max": 65,
        "age_range": [
          18,
          45
        ],
        "genders": [
          1
        ],
        "device_platforms": [
          "mobile",
          "desktop"
        ],
        "publisher_platforms": [
          "facebook"
        ],
        "facebook_positions": [
          "feed",
          "facebook_reels",
          "story"
        ],
        "locales": [
          27
        ],
        "geo_locations": {
          "countries": [
            "VN"
          ],
          "location_types": [
            "home",
            "recent"
          ]
        },
        "flexible_spec": [
          {
            "interests": [
              {
                "id": "6003070856229",
                "name": "Game (giải trí)"
              }
            ],
            "behaviors": [
              {
                "id": "6002714895372",
                "name": "Frequent Travelers"
              }
            ],
            "life_events": [
              {
                "id": "6002714398172",
                "name": "Newlywed (1 year)"
              }
            ],
            "relationship_statuses": [
              2,
              4,
              3
            ]
          }
        ],
        "targeting_automation": {
          "advantage_audience": 1
        }
      }
    }
  ],
  "summary": {
    "impressions": 11462,
    "clicks": 19,
    "reach": 11243,
    "spend": 135140,
    "cpc": 6827.631579,
    "cpm": 11790.263479,
    "cpp": 54927.700908,
    "ctr": 0.165765137,
    "frequency": 1.019478774
  },
  "page_number": 1,
  "page_size": 30,
  "total_entries": 4,
  "total_pages": 1
}
```

## List of ads

`GET /shops/{SHOP_ID}/ads_manager/ads_v2`

Get list of ads

### Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `SHOP_ID` | path | integer | yes | Shop ID |
| `page` | query | integer |  | Page number |
| `page_size` | query | integer |  | Number of records per page |
| `start_time` | query | integer (int64) |  | Start of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated from this time. |
| `end_time` | query | integer (int64) |  | End of the statistics period, as a Unix timestamp (seconds). The `insights` metrics are aggregated up to this time. |
| `select_fields` | query | string |  | Comma-separated list of additional `insights` fields to include in the response. When specified, only the listed fields are returned inside `insights` (in addition to the always-present base metrics). **Performance** - `ad_performance_session` — Overall performance - `spend` — Amount spent - `reach` — Instant Experience reach - `impressions` — Impressions - `clicks` — Clicks (all) - `frequency` — Frequency - `cpp` — CPP - `cpm` — CPM - `cpc` — CPC - `ctr` — CTR - `cost_per_1000_accounts_center_reach` — Cost per 1000 accounts center reach - `cost_per_result` — Cost per result - `avg_purchase_conversion_value` — Average purchase conversion value - `indicator_result` — Result - `result_roas` — Result ROAS **Engagement** - `ad_engagement_session` — Engagement - `link_click` — Link clicks - `like` — Facebook likes - `comment` — Post comments - `post_engagement` — Post engagements - `post_reaction` — Post reactions - `post` — Post shares - `onsite_conversion_post_save` — Post saves - `photo_view` — Photo views - `video_view` — Video plays (≥3s) - `inline_link_click_ctr` — CTR (link click-through rate) - `outbound_click` — Outbound clicks - `onsite_conversion_messaging_conversation_started_7d` — Messaging conversations started - `onsite_conversion_messaging_first_reply` — New messaging contacts - `onsite_conversion_messaging_block` — Messaging blocks - `video_thruplay_watched_actions` — ThruPlays - `video_play_actions` — Video plays - `video_p25_watched_actions` — Video plays at 25% - `video_p50_watched_actions` — Video plays at 50% - `video_p75_watched_actions` — Video plays at 75% - `video_p95_watched_actions` — Video plays at 95% - `video_p100_watched_actions` — Video plays at 100% - `estimated_ad_recallers` — Estimated ad recall lift (people) - `cost_per_outbound_click` — Cost per outbound click - `cost_per_thruplay` — Cost per ThruPlay - `outbound_clicks_ctr` — Outbound CTR - `cost_per_post_engagement` — Cost per post engagement - `estimated_ad_recall_rate` — Estimated ad recall lift rate - `cost_per_estimated_ad_recallers` — Cost per estimated ad recall lift - `cost_per_messaging_conversation_started` — Cost per messaging conversation started **Conversion** *Leads* - `lead` — Leads - `website_lead` — Website leads - `offline_lead` — Offline leads - `meta_lead` — Meta leads - `lead_conversion_value` — Lead conversion value - `website_lead_conversion_value` — Website lead conversion value - `offline_lead_conversion_value` — Offline lead conversion value - `meta_lead_conversion_value` — Meta lead conversion value - `cost_per_lead` — Cost per lead *Purchases* - `omni_purchase` — Purchases - `inapp_omni_purchase` — In-app purchases - `website_omni_purchase` — Website purchases - `offline_omni_purchase` — Offline purchases - `meta_omni_purchase` — Meta purchases - `omni_purchase_conversion_value` — Purchase conversion value - `inapp_omni_purchase_conversion_value` — In-app purchase conversion value - `website_omni_purchase_conversion_value` — Website purchase conversion value - `offline_omni_purchase_conversion_value` — Offline purchase conversion value - `meta_omni_purchase_conversion_value` — Meta purchase conversion value - `cost_per_omni_purchase` — Cost per purchase *Checkout initiated* - `omni_initiated_checkout` — Checkout initiated - `inapp_omni_initiated_checkout` — In-app checkout initiated - `website_omni_initiated_checkout` — Website checkout initiated - `offline_omni_initiated_checkout` — Offline checkout initiated - `meta_omni_initiated_checkout` — Meta checkout initiated - `omni_initiated_checkout_conversion_value` — Checkout initiation conversion value - `inapp_omni_initiated_checkout_conversion_value` — In-app checkout initiation conversion value - `website_omni_initiated_checkout_conversion_value` — Website checkout initiation conversion value - `offline_omni_initiated_checkout_conversion_value` — Offline checkout initiation conversion value - `meta_omni_initiated_checkout_conversion_value` — Meta checkout initiation conversion value - `cost_per_omni_initiated_checkout` — Cost per checkout initiated *Registrations completed* - `omni_complete_registration` — Registrations completed - `inapp_omni_complete_registration` — In-app registrations completed - `website_omni_complete_registration` — Website registrations completed - `offline_omni_complete_registration` — Offline registrations completed - `omni_complete_registration_conversion_value` — Registration completion conversion value - `inapp_omni_complete_registration_conversion_value` — In-app registration completion conversion value - `website_omni_complete_registration_conversion_value` — Website registration completion conversion value - `offline_omni_complete_registration_conversion_value` — Offline registration completion conversion value - `cost_per_omni_complete_registration` — Cost per registration completed *Content views* - `omni_view_content` — Content views - `inapp_omni_view_content` — In-app content views - `website_omni_view_content` — Website content views - `offline_omni_view_content` — Offline content views - `meta_omni_view_content` — Meta content views - `omni_view_content_conversion_value` — Content view conversion value - `inapp_omni_view_content_conversion_value` — In-app content view conversion value - `website_omni_view_content_conversion_value` — Website content view conversion value - `offline_omni_view_content_conversion_value` — Offline content view conversion value - `meta_omni_view_content_conversion_value` — Meta content view conversion value - `cost_per_omni_view_content` — Cost per content view *Searches* - `omni_search` — Searches - `inapp_omni_search` — In-app searches - `website_omni_search` — Website searches - `offline_omni_search` — Offline searches - `omni_search_conversion_value` — Search conversion value - `inapp_omni_search_conversion_value` — In-app search conversion value - `website_omni_search_conversion_value` — Website search conversion value - `offline_omni_search_conversion_value` — Offline search conversion value - `cost_per_omni_search` — Cost per search *Add to cart* - `omni_add_to_cart` — Add to cart - `inapp_omni_add_to_cart` — In-app add to cart - `website_omni_add_to_cart` — Website add to cart - `offline_omni_add_to_cart` — Offline add to cart - `meta_omni_add_to_cart` — Meta add to cart - `omni_add_to_cart_conversion_value` — Add-to-cart conversion value - `inapp_omni_add_to_cart_conversion_value` — In-app add-to-cart conversion value - `website_omni_add_to_cart_conversion_value` — Website add-to-cart conversion value - `offline_omni_add_to_cart_conversion_value` — Offline add-to-cart conversion value - `meta_omni_add_to_cart_conversion_value` — Meta add-to-cart conversion value - `cost_per_omni_add_to_cart` — Cost per add to cart *Add to wishlist* - `omni_add_to_wishlist` — Add to wishlist - `inapp_omni_add_to_wishlist` — In-app add to wishlist - `website_omni_add_to_wishlist` — Website add to wishlist - `offline_omni_add_to_wishlist` — Offline add to wishlist - `meta_omni_add_to_wishlist` — Meta add to wishlist - `omni_add_to_wishlist_conversion_value` — Add-to-wishlist conversion value - `inapp_omni_add_to_wishlist_conversion_value` — In-app add-to-wishlist conversion value - `website_omni_add_to_wishlist_conversion_value` — Website add-to-wishlist conversion value - `offline_omni_add_to_wishlist_conversion_value` — Offline add-to-wishlist conversion value - `meta_omni_add_to_wishlist_conversion_value` — Meta add-to-wishlist conversion value - `cost_per_omni_add_to_wishlist` — Cost per add to wishlist *Product customizations* - `customize_product_total` — Product customizations - `inapp_customize_product_total` — In-app product customizations - `website_customize_product_total` — Website product customizations - `offline_customize_product_total` — Offline product customizations - `customize_product_total_conversion_value` — Product customization conversion value - `inapp_customize_product_total_conversion_value` — In-app product customization conversion value - `website_customize_product_total_conversion_value` — Website product customization conversion value - `offline_customize_product_total_conversion_value` — Offline product customization conversion value - `cost_per_customize_product_total` — Cost per product customization *Trials started* - `start_trial_total` — Trials started - `inapp_start_trial_total` — In-app trials started - `website_start_trial_total` — Website trials started - `offline_start_trial_total` — Offline trials started - `start_trial_total_conversion_value` — Trial start conversion value - `inapp_start_trial_total_conversion_value` — In-app trial start conversion value - `website_start_trial_total_conversion_value` — Website trial start conversion value - `offline_start_trial_total_conversion_value` — Offline trial start conversion value - `cost_per_start_trial_total` — Cost per trial started *Subscriptions* - `subscribe_total` — Subscriptions - `inapp_subscribe_total` — In-app subscriptions - `website_subscribe_total` — Website subscriptions - `offline_subscribe_total` — Offline subscriptions - `subscribe_total_conversion_value` — Subscription conversion value - `inapp_subscribe_total_conversion_value` — In-app subscription conversion value - `website_subscribe_total_conversion_value` — Website subscription conversion value - `offline_subscribe_total_conversion_value` — Offline subscription conversion value - `cost_per_subscribe_total` — Cost per subscription *Applications submitted* - `submit_application_total` — Applications submitted - `inapp_submit_application_total` — In-app applications submitted - `website_submit_application_total` — Website applications submitted - `offline_submit_application_total` — Offline applications submitted - `meta_submit_application_total` — Meta applications submitted - `submit_application_total_conversion_value` — Application submission conversion value - `inapp_submit_application_total_conversion_value` — In-app application submission conversion value - `website_submit_application_total_conversion_value` — Website application submission conversion value - `offline_submit_application_total_conversion_value` — Offline application submission conversion value - `meta_submit_application_total_conversion_value` — Meta application submission conversion value - `cost_per_submit_application_total` — Cost per application submitted *Contacts* - `contact_total` — Contacts - `inapp_contact_total` — In-app contacts - `website_contact_total` — Website contacts - `offline_contact_total` — Offline contacts - `contact_total_conversion_value` — Contact conversion value - `inapp_contact_total_conversion_value` — In-app contact conversion value - `website_contact_total_conversion_value` — Website contact conversion value - `offline_contact_total_conversion_value` — Offline contact conversion value - `cost_per_contact_total` — Cost per contact *Landing page views* - `landing_page_view` — Landing page views - `inapp_landing_page_view` — In-app landing page views - `website_landing_page_view` — Website landing page views - `cost_per_landing_page_view` — Cost per landing page view *Orders* - `order_created` — Orders created - `order_shipped` — Orders shipped *Purchase ROAS* - `purchase_roas` — Purchase ROAS - `inapp_purchase_roas` — In-app purchase ROAS - `website_purchase_roas` — Website purchase ROAS |

### Responses

- `200` Success (AdListResponse)

```json
{
  "success": true,
  "data": [
    {
      "id": "120238954106070738",
      "name": "Quảng cáo sale nam giới",
      "status": "ACTIVE",
      "effective_status": "ACTIVE",
      "created_time": "2026-01-21T09:12:15",
      "marketer_id": null,
      "product_id": null,
      "product_category_id": null,
      "ad_account": {
        "id": "1427880307614733",
        "name": "Quỳnh Dương",
        "currency": "VND"
      },
      "ad_campaign": {
        "id": "120238946624470738",
        "name": "Chiến dịch siêu sale tháng 2/2026"
      },
      "ad_set": {
        "id": "120238954106080738",
        "name": "Nhóm nam giới"
      },
      "ad_creative": {
        "id": "1175732824344796",
        "name": "✨ CƠ HỘI DUY NHẤT ĐỂ SỞ HỮU TRANG SỨC NIMORA VỚI ƯU ĐÃI ĐẾN 70% ✨",
        "object_story_id": "926757717191948_122108102433202138",
        "object_story_spec": null
      },
      "insights": {
        "ad_ids": [
          "120238954106070738"
        ],
        "impressions": 8252,
        "clicks": 4,
        "reach": 8121,
        "spend": 57381,
        "cpc": 14345.25000025,
        "cpm": 6953.58700888221,
        "cpp": 7078.91138298451,
        "ctr": 0.0484730974309258,
        "frequency": 1.011012
      }
    }
  ],
  "summary": {
    "impressions": 11462,
    "clicks": 19,
    "reach": 11243,
    "spend": 135140,
    "cpc": 6827.631579,
    "cpm": 11790.263479,
    "cpp": 54927.700908,
    "ctr": 0.165765137,
    "frequency": 1.019478774
  },
  "page_number": 1,
  "page_size": 30,
  "total_entries": 4,
  "total_pages": 1
}
```