Display
/
Get ad's details

AdFlex API (1.0.0)

API for Getting and searching ads of all platforms.

Languages
Servers
Mock server
https://adflex.redocly.app/_mock/openapi/
Server
https://api.adflex.io/api/{version}/

Facebook

Operations

Meta

Operations

Native

Operations

Display

Operations

Get search filters

Request

curl -i -X GET \
  'https://adflex.redocly.app/_mock/openapi/filters/display/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 publishers items

Request

Bodyapplication/jsonrequired
searchstring

The text to be searched

Example: "club"
idArray of integers
Example: [1000]
curl -i -X GET \
  'https://adflex.redocly.app/_mock/openapi/display/filter/publishers/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 display ads

Request

Bodyapplication/jsonrequired
last_hitinteger

after first page send the current timestamp in seconds

pageinteger
Default 1
Example: 1
orderbystring
Default "updated_at"
Enum"updated_at""impressions""days_active""domain.traffic"
Example: "updated_at"
curl -i -X POST \
  'https://adflex.redocly.app/_mock/openapi/display/ads/search?api_key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "page": 1,
    "orderby": "updated_at"
  }'

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://adflex.redocly.app/_mock/openapi/display/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": { … }
  }
}

Pinterest

Operations

Reddit

Operations

X

Operations

Youtube

Operations