Facebook

AdFlex API (1.0.0)

API for Getting and searching ads of all platforms.

Languages
Servers
Server

https://api.adflex.io/api/{version}/

Facebook

Operations

Get search filters

Request

curl -i -X GET \
  'https://api.adflex.io/api/v1/filters/facebook/search?api_key=YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
statusstringrequired
Enum"ok""failed"
metaobjectrequired
meta.​codeinteger
Example: 1000
meta.​messagestring or null
Example: null
dataobject(FilterGroup)required
Example: {"key":null,"label":"Targeting","icon":"target","collapse":false,"description":null,"mode":"advanced","filters":[],"relations":[["countries","exact_country"]]}
data.​filtersArray of objects
Example: []
data.​relationsArray of strings
Example: [["countries","exact_country"]]
Response
application/json
{
  "status": "ok",
  "meta": {
    "code": 1000,
    "message": null
  },
  "data": {
    "filters": [ … ],
    "relations": [ … ]
  }
}

Get interests items

Request

Bodyapplication/jsonrequired
searchstring

The text to be searched

Example: "club"
idArray of integers
Example: [1000]
curl -i -X GET \
  'https://api.adflex.io/api/v1/facebook/filter/interests/items?api_key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "search": "club",
    "id": [
      1000
    ]
  }'

Responses

OK

Bodyapplication/json
statusstringrequired
Enum"ok""failed"
metaobjectrequired
meta.​codeinteger
Example: 1000
meta.​messagestring or null
Example: null
dataArray of objectsrequired
data[].​keyinteger or string

Item key

One of:

Item key

integer

Item key

data[].​labelstring or null

Item value

data[].​iconstring or null

Item icon if available

data[].​actionstring or null

Item action if available

Enum"SINGLETON_RELATION""DESELECT_OTHER""DISABLE_OTHER""RESET_RELATION_ON_EMPTY"
Response
application/json
{
  "status": "ok",
  "meta": {
    "code": 1000,
    "message": null
  },
  "data": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Get fanpage categories items

Request

Bodyapplication/jsonrequired
searchstring

The text to be searched

Example: "club"
idArray of integers
Example: [1000]
curl -i -X GET \
  'https://api.adflex.io/api/v1/facebook/filter/fanpage_categories/items?api_key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "search": "club",
    "id": [
      1000
    ]
  }'

Responses

OK

Bodyapplication/json
statusstringrequired
Enum"ok""failed"
metaobjectrequired
meta.​codeinteger
Example: 1000
meta.​messagestring or null
Example: null
dataArray of objectsrequired
data[].​keyinteger or string

Item key

One of:

Item key

integer

Item key

data[].​labelstring or null

Item value

data[].​iconstring or null

Item icon if available

data[].​actionstring or null

Item action if available

Enum"SINGLETON_RELATION""DESELECT_OTHER""DISABLE_OTHER""RESET_RELATION_ON_EMPTY"
Response
application/json
{
  "status": "ok",
  "meta": {
    "code": 1000,
    "message": null
  },
  "data": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Search in facebook ads

Request

Bodyapplication/jsonrequired
last_hitinteger

after first page send the current timestamp in seconds

pageinteger
Default 1
Example: 1
behaviorsArray of integers
Example: [4026]
interestsArray of integers
Example: [10,4]
search_fieldArray of objects
Example: [{"type":"text","text":"order"},{"type":"without_fanpage","text":"MSI"}]
orderbystring
Default "updated_at"
Enum"popularity""updated_at""seen_counts""running_longest"
Example: "updated_at"
curl -i -X POST \
  'https://api.adflex.io/api/v1/facebook/ads/search?api_key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": 1,
    "orderby": "updated_at",
    "gender": [
      9886
    ],
    "behaviors": [
      4026
    ],
    "interests": [
      10,
      4
    ],
    "search_field": [
      {
        "type": "text",
        "text": "order"
      },
      {
        "type": "without_fanpage",
        "text": "MSI"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
statusstringrequired
Enum"ok""failed"
metaobjectrequired
meta.​codeinteger
Example: 1000
meta.​messagestring or null
Example: null
dataobjectrequired
data.​adsArray of objects
data.​current_pageinteger

Current request page

Example: 1
data.​has_next_pageboolean

Defines that next page has ads or not

data.​last_hitinteger

after first page send the current timestamp in seconds

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

Get ad's details

Request

Path
adintegerrequired

Ad id

curl -i -X GET \
  'https://api.adflex.io/api/v1/facebook/ads/{ad}?api_key=YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
statusstringrequired
Enum"ok""failed"
metaobjectrequired
meta.​codeinteger
Example: 1000
meta.​messagestring or null
Example: null
dataobjectrequired
data.​dataobject
Response
application/json
{
  "status": "ok",
  "meta": {
    "code": 1000,
    "message": null
  },
  "data": {
    "data": { … }
  }
}

Meta

Operations

Native

Operations

Display

Operations

Pinterest

Operations

Reddit

Operations

X

Operations

Youtube

Operations