Search Facebook ads

Request

Security

ApiKeyAuth

Bodyapplication/jsonrequired

last_hitinteger, (int64)

Snapshot timestamp returned in data.last_hit by the page 1 response. Omit this field for page 1. For page 2 and later, resend the original value unchanged while using the same filters and sorting. This value does not expire.

pageinteger, >= 1

Requested page number. Each page returns up to 18 ads. The page size is fixed and cannot be changed.

Default:1

Example:1

advanced_orderobject

Example:

{
  "orderby": "newest",
  "order": "desc"
}

target_ageArray of integers

Example:

[
  18,
  65
]

owner_categoriesArray of integers

Example:

[
  109527622457518,
  2256,
  2201,
  201429350256874,
  197048876974331,
  200046713342752
]

genderArray of integers

Example:

[
  9886
]

behaviorsArray of integers

Example:

[
  4026
]

interestsArray of integers

Example:

[
  10,
  4
]

search_fieldArray of objects

Example:

[
  {
    "type": "text",
    "text": "PlayStation"
  },
  {
    "type": "without_owner",
    "text": "MSI"
  }
]

POST

/v2/ads/facebook/search

curl -i -X POST \
  https://api.adflex.io/api/v2/ads/facebook/search \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "page": 1,
    "advanced_order": {
      "orderby": "newest",
      "order": "desc"
    },
    "target_age": [
      18,
      65
    ],
    "owner_categories": [
      109527622457518,
      2256,
      2201,
      201429350256874,
      197048876974331,
      200046713342752
    ],
    "gender": [
      9886
    ],
    "behaviors": [
      4026
    ],
    "interests": [
      10,
      4
    ],
    "search_field": [
      {
        "type": "text",
        "text": "PlayStation"
      },
      {
        "type": "without_owner",
        "text": "MSI"
      }
    ]
  }'

Responses

Bodyapplication/json

statusstringrequired

Enum:"ok""failed"

metaobjectrequired

dataobjectrequired

Response

{
  "status": "ok",
  "meta": {
    "code": 1000,
    "message": null
  },
  "data": {
    "ads": [ … ],
    "current_page": 1,
    "has_next_page": true,
    "last_hit": 12321321
  }
}