activeBanners

Get a list of active banners for the specified date.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=activeBanners
  & date=<YYYY-MM-DD>

date*

Date that falls within the period of banner activity (that is, the time when the banner was displayed and has statistics on impressions and/or clicks).

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <campaignID>{integer}</campaignID>
    <campaignName>{string}</campaignName>
    <campaignDateStart>{date}</campaignDateStart>
    <campaignDateEnd>{date}</campaignDateEnd>
    <bannerTypeID>{integer}</bannerTypeID>
    <bannerTypeName>{string}</bannerTypeName>
    <status>{integer}</status>
    <isUnplaced>{integer}</isUnplaced>
    <priority>{integer}</priority>
    <impressions>{integer}</impressions>
    <impressionsToday>{integer}</impressionsToday>
    <impressionsHour>{integer}</impressionsHour>
    <clicks>{integer}</clicks>
    <clicksToday>{integer}</clicksToday>
    <clicksHour>{integer}</clicksHour>
    <dateStart>{date}</dateStart>
    <dateEnd>{date}</dateEnd>
    <dateAdded>{date}</dateAdded>
  </row0>
</data>
</result>
</response>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

rows

Number of items in the response tree.

rowN

Item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

ID

The banner ID.

name

Banner name.

campaignID

Campaign ID.

campaignName

Campaign name.

campaignDateStart

Campaign start date.

campaignDateEnd

Campaign end date.

bannerTypeID

Banner type ID.

bannerTypeName

Banner type name.

status

Status.

Acceptable values:

  • 0: Active.
  • 1: Paused.
  • 2: Completed.

isUnplaced

Banner placement.

Acceptable values:

  • 0: Enabled.
  • 1: Disabled.

priority

Priority.

impressions

Total number of banner impressions.

impressionsToday

Number of impressions today.

impressionsHour

Number of impressions in the current hour.

clicks

Total number of banner clicks.

clicksToday

Number of clicks today.

clicksHour

Number of clicks in the current hour.

dateStart

Delivery start date.

dateEnd

Delivery end date.

dateAdded

Add date.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=activeBanners&date=YYYY-MM-DD

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>900088</ID>
    <name>#900088</name>
    <campaignID>321510</campaignID>
    <campaignName>1</campaignName>
    <campaignDateStart>2020-11-27 00:00:00</campaignDateStart>
    <campaignDateEnd/>
    <bannerTypeID>17</bannerTypeID>
    <bannerTypeName>600x90</bannerTypeName>
    <status>0</status>
    <isUnplaced>0</isUnplaced>
    <priority>100</priority>
    <impressions>4</impressions>
    <impressionsToday>0</impressionsToday>
    <impressionsHour>0</impressionsHour>
    <clicks>0</clicks>
    <clicksToday>0</clicksToday>
    <clicksHour>0</clicksHour>
    <dateStart>2021-11-27 00:00:00</dateStart>
    <dateEnd/>
    <dateAdded>2021-11-27 13:09:57</dateAdded>
  </row0>
</data>
</result>
</response>
Previous
zone
Next
advertiser
In this article: