# Store Meta Ads Library Facebook Advertiser Pages List API

## API Information

- **API Name**: Get Store Facebook Advertiser Pages List
- **Request Method**: POST
- **API Endpoint**: `/open-api/v1/data`
- **API Path**: `/v3/api/open/ppspy/pp-stores/fb-page`
- **API Description**: Retrieve the list of Facebook advertiser pages associated with a specified store, including page basic information, follower count, ad count, ad platforms, etc., to help analyze the store's advertising account layout and advertising strategy
- **Pricing**: `Free`

**Request Headers:**

- Content-Type: application/json
- Accept: application/json

## Request Parameters

### Request Structure

| Parameter | Type   | Description                        | Example                                 | Required | Default |
| --------- | ------ | ---------------------------------- | --------------------------------------- | -------- | ------- |
| key       | string | User's external API request key    | "your_api_key_here"                     | Yes      |         |
| uri       | string | API path                           | "/v3/api/open/ppspy/pp-stores/fb-page"  | Yes      |         |
| params    | object | API input parameter object         | See parameter list                      | Yes      |         |

### Request Body Parameters (params object)

| Parameter    | Type   | Required | Description                                                                                                                                               |
| ------------ | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id           | String | Yes      | Store unique identifier ID, a 13-character string (e.g., `c2d5b2547218a`), corresponds to the `store_id` field in the store ranking list API response   |
| page_size    | Long   | No       | Number of records per page, specifies the number of pages returned per page. Default: 20                                                                 |
| current_page | Long   | No       | Current page number, pages start from 1. Default: 1                                                                                                       |

### Request Example

```bash
curl -X POST "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/ppspy/pp-stores/fb-page",
    "params": {
        "id": "c2d5b2547218a",
        "page_size": 20,
        "current_page": 1
    }
  }'
```

## Response Parameters

### Response Body Structure

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "current_page": 1,
    "data": [],
    "first_page_url": "",
    "from": 1,
    "is_logged_in": false,
    "last_page": 1,
    "last_page_url": "",
    "next_page_url": null,
    "path": "",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 100
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}
```

### Response Field Description

| Field     | Type    | Description                              |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | Response status code, 200 means success  |
| message   | String  | Response message                         |
| data      | Object  | Response data                            |
| version   | String  | API version                              |
| timestamp | String  | Response timestamp                       |
| sign      | String  | Response signature                       |
| remaining_credits | Long    | Current remaining available credits after this request |
| consumed_credits  | Long    | Credits consumed by this request                       |
| success   | Boolean | Whether the request was successful       |
| fail      | Boolean | Whether the request failed               |

### Pagination Data Fields (data.data)

| Field          | Type    | Description                                                                                         |
| -------------- | ------- | --------------------------------------------------------------------------------------------------- |
| current_page   | Long    | Current page number                                                                                 |
| data           | Array   | Facebook advertiser pages list                                                                      |
| first_page_url | String  | URL of the first page                                                                               |
| from           | Long    | Starting record position (position of the first record of the current page in the total result set) |
| is_logged_in   | Boolean | Whether the user is logged in, used to identify data permission status                              |
| last_page      | Long    | Last page number (total pages)                                                                      |
| last_page_url  | String  | URL of the last page                                                                                |
| next_page_url  | String  | URL of the next page, null if no next page                                                          |
| path           | String  | API request path                                                                                    |
| per_page       | Long    | Number of records per page                                                                          |
| prev_page_url  | String  | URL of the previous page, null if no previous page                                                  |
| to             | Long    | Ending record position (position of the last record of the current page in the total result set)    |
| total          | Long    | Total number of records                                                                             |

### Facebook Advertiser Page Fields (Datum)

| Field                | Type    | Description                                                                                                                                                |
| -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                   | String  | Facebook page unique identifier ID                                                                                                                         |
| name                 | String  | Facebook page name                                                                                                                                         |
| profile_picture_url  | String  | Facebook page avatar image URL                                                                                                                             |
| category_name        | String  | Facebook page category name (e.g., Shopping & Retail, Brand, E-commerce Website, etc.)                                                                    |
| like_count           | Long    | Number of likes on the Facebook page (follower count)                                                                                                      |
| creation_time        | Long    | Facebook page creation time, Unix timestamp (seconds)                                                                                                      |
| ad_platform          | Array   | List of ad platforms, indicating which platforms this page has advertised on (e.g., FACEBOOK, INSTAGRAM, MESSENGER, AUDIENCE_NETWORK, etc.)               |
| ad_count             | Long    | Total number of ads for this page                                                                                                                          |
| ad_source            | Integer | Ad data source type. 1-TikTok, 2-Facebook, 3-Meta Ads Library                                                                                             |
| source_advertiser_id | String  | Original advertiser ID (unique advertiser identifier from the source platform)                                                                             |
| store_ad_count       | Long    | Number of ads this page has placed for the current store                                                                                                   |
| ads_library_link     | String  | Meta Ads Library link, can directly jump to Facebook's official Ads Library to view all ads for this page                                                 |

## Response Example

```json
{
  "code": 200,
  "message": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": "page_001",
        "name": "Fashion Store Official",
        "profile_picture_url": "https://example.com/images/page_avatar_001.jpg",
        "category_name": "Shopping & Retail",
        "like_count": 125000,
        "creation_time": 1520000000,
        "ad_platform": [
          "FACEBOOK",
          "INSTAGRAM"
        ],
        "ad_count": 350,
        "ad_source": 3,
        "source_advertiser_id": "100123456789012",
        "store_ad_count": 280,
        "ads_library_link": "https://www.facebook.com/ads/library/?active_status=all&ad_type=all&country=ALL&view_all_page_id=100123456789012"
      },
      {
        "id": "page_002",
        "name": "Fashion Store - US",
        "profile_picture_url": "https://example.com/images/page_avatar_002.jpg",
        "category_name": "E-commerce Website",
        "like_count": 45000,
        "creation_time": 1580000000,
        "ad_platform": [
          "FACEBOOK",
          "INSTAGRAM",
          "MESSENGER"
        ],
        "ad_count": 180,
        "ad_source": 3,
        "source_advertiser_id": "100987654321098",
        "store_ad_count": 150,
        "ads_library_link": "https://www.facebook.com/ads/library/?active_status=all&ad_type=all&country=ALL&view_all_page_id=100987654321098"
      },
      {
        "id": "page_003",
        "name": "Fashion Deals & Offers",
        "profile_picture_url": "https://example.com/images/page_avatar_003.jpg",
        "category_name": "Brand",
        "like_count": 8500,
        "creation_time": 1650000000,
        "ad_platform": [
          "FACEBOOK"
        ],
        "ad_count": 45,
        "ad_source": 3,
        "source_advertiser_id": "100111222333444",
        "store_ad_count": 45,
        "ads_library_link": "https://www.facebook.com/ads/library/?active_status=all&ad_type=all&country=ALL&view_all_page_id=100111222333444"
      }
    ],
    "first_page_url": "https://api.example.com/pages?page=1",
    "from": 1,
    "is_logged_in": false,
    "last_page": 2,
    "last_page_url": "https://api.example.com/pages?page=2",
    "next_page_url": "https://api.example.com/pages?page=2",
    "path": "https://api.example.com/pages",
    "per_page": 20,
    "prev_page_url": null,
    "to": 3,
    "total": 25
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}
```

## Error Code Description

| Error Code | Description               |
| ---------- | ------------------------- |
| 200        | Success                   |
| 400        | Invalid request parameters|
| 401        | Unauthorized              |
| 403        | Insufficient permissions  |
| 500        | Internal server error     |
