Superpools

Access to superpools is provided to all users who have the appropriate permission in their personal account.
For getting information about superpools, the following requests are provided:

List

The list method allows you to get a list of the superpools

Request:

{site_path}/{lang}/api/super-pool/list

GET parameters list:

filter	array	Allows filtering data by all available fields
fields	string	Allows to select only the specified fields from all available
sort	string	Allows you to sort asc and desc entities by all available fields
page	int	Allows you to pass the page number of the list of entities

List of all available fields

id	int	Superpool ID
name	string	Superpool name
format	int	Superpool size
type	int	Superpool type ID
assignID	int	ID of the user responsible for the superpool
created_by	int	Superpool creator's ID
updated_by	int	ID of the last user who edited the superpool
created_at	int	UTC superpool creation time
updated_at	int	UTC last edit time
typeName	string	Superpool type
clicks	int	Total clicks
clicksToday	int	Clicks for the current day
clicksYtd	int	Clicks over the past day
views	int	Total views
viewsToday	int	Views for the current day
viewsYtd	int	Views over the past day
active	boolean	Superpool status Values: 1 - enabled 0 - disabled
tag	array	Tags

Response

The response is transmitted in JSON format. List of response fields:

result	array	List of superpools based on query parameters
_links	array	List of navigation links. May contain the following elements: self - contains a link to the current page of the list first - contains a link to the first page of the list last - contains a link to the last page of the list prev - contains a link to the previous page of the list next - contains a link to the next page of the list
_meta	array	Information on list navigation. Contains elements: totalCount - total number of available entities considering all selected parameters pageCount - the sequence number of the entity in the list that starts the current page currentPage - number of the current page perPage - number of entities displayed on one page

Request example:


              {site_path}/{lang}/api/super-pool/list?filter[id][in][]=1225878269&filter[id][in][]=1228963959&sort=name

Response example:

{
  "result": [
    {
      "id": 1225878269,
      "name": "another superpool name",
      "format": 0,
      "typeID": 1,
      "assignID": 0,
      "created_by": 1214768575,
      "created_at": 1530824611,
      "updated_by": 1214768575,
      "updated_at": 1530824611,
      "typeName": "branding",
      "views": "237846518",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "1038323",
      "clicksToday": "4",
      "clicksYtd": "5",
      "active": "1",
      "tag": {
        "1": "sport",
        "2": "general"
      }
    },
    {
      "id": 1228963959,
      "name": "superpool name",
      "format": 0,
      "typeID": 6,
      "assignID": 0,
      "created_by": 1839588080,
      "created_at": 1568892857,
      "updated_by": 1839588080,
      "updated_at": 1570797146,
      "typeName": "VAST",
      "views": "28781804",
      "viewsToday": "82451",
      "viewsYtd": "219562",
      "clicks": "1704737",
      "clicksToday": "5026",
      "clicksYtd": "13378",
      "active": "1",
      "tag": {
        "2": "general"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/super-pool/list?filter%5Bid%5D%5Bin%5D%5B0%5D=1228963959&filter%5Bid%5D%5Bin%5D%5B1%5D=1225878269&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

View

The view method provides extended information about the superpools

Request:

{site_path}/{lang}/api/super-pool/view/[id]

GET parameters list:

id	int	It is a required parameter. Superpool nubmer
fields	string	Allows to select only the specified fields from all available *Does not apply to related entity fields

List of all available fields

id	int	Superpool ID
name	string	Superpool name
format	int	Superpool size
type	int	Superpool type ID
assignID	int	ID of the user responsible for the superpool
created_by	int	Superpool creator's ID
updated_by	int	ID of the last user who edited the superpool
created_at	int	UTC superpool creation time
updated_at	int	UTC last edit time
typeName	string	Superpool type
clicks	int	Total clicks
clicksToday	int	Clicks for the current day
clicksYtd	int	Clicks over the past day
views	int	Total views
viewsToday	int	Views for the current day
viewsYtd	int	Views over the past day
active	boolean	Superpool status Values: 1 - enabled 0 - disabled
auction	array	Auctions May contain: - Campaigns - Segments
pool	array	Pools related to the superpool May contain: - Pools - Segments
tag	array	Tags

Request example:


              {site_path}/{lang}/api/super-pool/view/1297235890

Response example:

{
  "id": 1297235890,
  "name": "superpool name",
  "format": 0,
  "typeID": 10,
  "assignID": 0,
  "created_by": 1839588080,
  "created_at": 1574934147,
  "updated_by": 1839588080,
  "updated_at": 1574934147,
  "typeName": "VAST",
  "views": "28781804",
  "viewsToday": "82451",
  "viewsYtd": "219562",
  "clicks": "1704737",
  "clicksToday": "5026",
  "clicksYtd": "13378",
  "active": 1,
  "auction": [
    {
      "type": "segment",
      "id": "1940156536",
      "name": "segment name",
      "userID": "1443076549",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "48280",
      "viewsToday": "395",
      "viewsYtd": "715",
      "clicks": "295",
      "clicksToday": "3",
      "clicksYtd": "5",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574935590",
      "attach_updated_at": "1574935590",
      "attached": "1",
      "active": "1"
    },
    {
      "type": "segment",
      "id": "2005158834",
      "name": "another name",
      "userID": "1968035714",
      "assignID": "0",
      "chain": "0",
      "priority": "1",
      "views": "1515932",
      "viewsToday": "11963",
      "viewsYtd": "24569",
      "clicks": "13600",
      "clicksToday": "91",
      "clicksYtd": "184",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574939665",
      "attach_updated_at": "1574939665",
      "attached": "1",
      "active": "1"
    }
  ],
  "pool": [
    {
      "type": "pool",
      "id": "1773271312",
      "name": "pool name",
      "active": "1",
      "attached": "1",
      "chain": "0",
      "priority": "1",
      "views": "0",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1839588080",
      "updated_by": "1839588080",
      "created_at": "1574934116",
      "updated_at": "1574934116",
      "attach_created_by": "1839588080",
      "attach_updated_by": "1839588080",
      "attach_created_at": "1574934147",
      "attach_updated_at": "1574934147"
    },
    {
      "type": "segment",
      "id": "1940156536",
      "name": "another name",
      "active": "1",
      "attached": "0",
      "chain": "0",
      "priority": "1",
      "views": "159",
      "viewsToday": "0",
      "viewsYtd": "0",
      "clicks": "0",
      "clicksToday": "0",
      "clicksYtd": "0",
      "created_by": "1839588080",
      "updated_by": "1839588080",
      "created_at": "1574935590",
      "updated_at": "1574935590",
      "attach_created_by": "0",
      "attach_updated_by": "0",
      "attach_created_at": "0",
      "attach_updated_at": "0"
    },
  ],
  "tag": [
    {"id": 1, "name": "sport"},
    {"id": 2, "name": "general"},
  ]
}