bannerPlaceReport

Get statistics on campaigns/banners/placements for the day. The method is available for users with the “administrator” role only.

Request format

Note

Pagination available.

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

date*

Date that you need to get data for.

Default value: today.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <campaignID>{integer}</campaignID>
    <campaignName>{string}</campaignName>
    <bannerID>{integer}</bannerID>
    <bannerName>{string}</bannerName>
    <siteID>{integer}</siteID>
    <siteName>{string}</siteName>
    <sectionID>{integer}</sectionID>
    <sectionName>{string}</sectionName>
    <placeID>{integer}</placeID>
    <placeName>{string}</placeName>
    <impressions>{integer}</impressions>
    <clicks>{integer}</clicks>
    <bannerTypeID>{integer}</bannerTypeID>
    <bannerTypeIDName>{string}</bannerTypeIDName>
  </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.
`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).
`campaignID`	Campaign ID.
`campaignName`	Campaign name.
`bannerID`	Banner ID.
`bannerName`	Banner name.
`siteID`	ID of the site in management.
`siteName`	Name of the site in management.
`sectionID`	Site section ID.
`sectionName`	Name of the site section.
`placeID`	Placement ID.
`placeName`	Placement name.
`impressions`	Total number of banner impressions.
`clicks`	Total number of banner clicks.
`bannerTypeID`	Banner type ID.
`bannerTypeName`	Banner type name.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=bannerPlaceReport&date=2022-01-27

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <campaignID>457410</campaignID>
    <campaignName>example</campaignName>
    <bannerID>1240863</bannerID>
    <bannerName>banner_test</bannerName>
    <siteID>35001</siteID>
    <siteName>site_test</siteName>
    <sectionID>73929</sectionID>
    <sectionName>section_test</sectionName>
    <placeID>772394</placeID>
    <placeName>place_test</placeName>
    <impressions>503</impressions>
    <clicks>0</clicks>
    <bannerTypeID>87751</bannerTypeID>
    <bannerTypeIDName>type_1</bannerTypeIDName>
  </row0>
</data>
</result>
</response>

Was the article helpful?

bannerPlacements

bannerType