website

Get a list of websites.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=website
  & [actionObjectID=<integer>]

actionObjectID

To get data for only one website, specify its ID.

Default value: 0 (display the list of all websites).

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <URL>{string}</URL>
    <isActive>{integer}</isActive>
    <webmasterID>{integer}</webmasterID>
    <webmasterAccount>{string}</webmasterAccount>
    <adNetworkID>{integer}</adNetworkID>
    <adNetworkName>{string}</adNetworkName>
    <categoryID>{integer}</categoryID>
    <categoryName>{string}</categoryName>
    <loadsToday>{integer}</loadsToday>
    <impressionsToday>{integer}</impressionsToday>
    <impressionsDefaultToday>{integer}</impressionsDefaultToday>
    <clicksToday>{integer}</clicksToday>
    <CTRToday>{integer}</CTRToday>
    <isReferrerByURL>{integer}</isReferrerByURL>
    <templateTypeID>{integer}</templateTypeID>
    <template>{string}</template>
    <dateAdded>{date}</dateAdded>
    <platformName>{string}</platformName>
    <platformType>{integer}</platformType>
    <contractorID>{integer}</contractorID>
    <url>{string}</url>
    <isMobileApp>{integer}</isMobileApp>
  </row>
</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

Unique ID of the site in management.

name

The name of the site.

webmasterID

Site owner ID.

webmasterAccount

Site owner username.

categoryID

ID of the category assigned to the site.

categoryName

Name of the category assigned to the site.

loadsToday

Tag information. Code requests today.

impressionsToday

Tag information. Impressions today.

impressionsDefaultToday

Tag information. Unfilled ad responses today.

clicksToday

Tag information. Clicks today.

CTRToday

Tag information. CTR today.

template

Referer template.

dateAdded

Add date.

platformName

Platform name.

platformType

Platform type.

Acceptable values:

  • 0: App.
  • 1: Webite.
  • 2: Information system.

contractorID

Contractor ID.

url

Webite or video resource domain, a blog URL, or a link for downloading an app.

isMobileApp

The platform is an app with mobile mediation.

Acceptable values:

  • 0: No.
  • 1: Yes.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=website

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>27185</ID>
    <name>site</name>
    <URL/>
    <isActive>1</isActive>
    <webmasterID/>
    <webmasterAccount/>
    <adNetworkID/>
    <adNetworkName/>
    <categoryID/>
    <categoryName/>
    <loadsToday>0</loadsToday>
    <impressionsToday>0</impressionsToday>
    <impressionsDefaultToday>0</impressionsDefaultToday>
    <clicksToday>0</clicksToday>
    <CTRToday>0.0000</CTRToday>
    <isReferrerByURL>0</isReferrerByURL>
    <templateTypeID>0</templateTypeID>
    <template/>
    <dateAdded>2021-11-27</dateAdded>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the website object:

Previous
webmaster
Next
zone
In this article: