assistant

Request format
Response format
Response parameters
Other actions with the object

Get a list of users with the “assistant” type.

Request format

Note

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

actionObjectID

To get data for only one assistant, specify their ID.

Default value: 0 (display the list of all users with the “assistant” type).

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <account>{string}</account>
    <company>{string}</company>
    <firstName>{string}</firstName>
    <lastName>{string}</lastName>
    <eMail>{string}</eMail>
    <country>{string}</country>
    <state>{string}</state>
    <city>{string}</city>
    <ZIPCode>{string}</ZIPCode>
    <address1>{string}</address1>
    <address2>{string}</address2>
    <phone>{string}</phone>
    <fax>{string}</fax>
    <dateAdded>{string}</dateAdded>
  <modules>
    <isViewOwnCampaigns>{integer}</isViewOwnCampaigns>
    <isCreateOwnCampaigns>{integer}</isCreateOwnCampaigns>
    <isModifyOwnCampaigns>{integer}</isModifyOwnCampaigns>
    <isAdvertisers>{integer}</isAdvertisers>
    <isViewAllCampaigns>{integer}</isViewAllCampaigns>
    <isModifyAllCampaigns>{integer}</isModifyAllCampaigns>
    <isModifyWebsites>{integer}</isModifyWebsites>
    <isWebsites>{integer}</isWebsites>
    <isPlacementPrices>{integer}</isPlacementPrices>
    <isHideInformation>{integer}</isHideInformation>
    <isCommonReports>{integer}</isCommonReports>
    <isExtendedReports>{integer}</isExtendedReports>
    <isFinancialReports>{integer}</isFinancialReports>
  </modules>
  </row0>
</data>
</result>
</response>

Response parameters

`code`	Request processing status. For the key, see here.
`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 user with the “assistant” type.
`account`	Assistant's account.
`company`	Company name.
`firstName`	Assistant's name.
`eMail`	Email address that the assistant's access is registered to.
`country`	Country.
`state`	Region.
`city`	City.
`ZIPCode`	Postal code.
`address1`	Address.
`address2`	Address (continued).
`phone`	Phone number.
`fax`	Fax.
`dateAdded`	Date when the user with the “assistant” type was added.
`modules`	Access rights setup.
`isViewOwnCampaigns`	View campaigns assigned to the assistant.
`isCreateOwnCampaigns`	Create campaigns assigned to the assistant.
`isModifyOwnCampaigns`	Manage campaigns assigned to the assistant.
`isAdvertisers`	Create own advertisers.
`isViewAllCampaigns`	View all campaigns.
`isModifyAllCampaigns`	Manage all campaigns.
`isModifyWebsites`	Manage all sites.
`isWebsites`	View all sites.
`isPlacementPrices`	View placement prices.
`isHideInformation`	Hide campaign priorities.
`isCommonReports`	View general reports.
`isExtendedReports`	View reports for planning.
`isFinancialReports`	Access reports of the “management/accounting” type.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>203478</ID>
    <account>ivanov</account>
    <company>Example LLC</company>
    <firstName>Ivan</firstName>
    <lastName>Ivanov</lastName>
    <eMail>ivanov@yandex.com</eMail>
    <country>Russian Federation</country>
    <state/>
    <city>Moscow</city>
    <ZIPCode>123456</ZIPCode>
    <address1>ul. Stroiteley, 3</address1>
    <address2>room 305</address2>
    <phone>+7 (495) 555-55-55</phone>
    <fax/>
    <dateAdded>0000-00-00</dateAdded>
  <modules>
    <isViewOwnCampaigns>0</isViewOwnCampaigns>
    <isCreateOwnCampaigns>0</isCreateOwnCampaigns>
    <isModifyOwnCampaigns>0</isModifyOwnCampaigns>
    <isAdvertisers>0</isAdvertisers>
    <isViewAllCampaigns>0</isViewAllCampaigns>
    <isModifyAllCampaigns>0</isModifyAllCampaigns>
    <isModifyWebsites>0</isModifyWebsites>
    <isWebsites>0</isWebsites>
    <isPlacementPrices>0</isPlacementPrices>
    <isHideInformation>0</isHideInformation>
    <isCommonReports>0</isCommonReports>
    <isExtendedReports>0</isExtendedReports>
    <isFinancialReports>0</isFinancialReports>
  </modules>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the assistant object:

assistant

Request formatRequest format

Response formatResponse format

Response parametersResponse parameters

Sample request and responseSample request and response

Other actions with the objectOther actions with the object

Was the article helpful?

Request format

Response format

Response parameters

Sample request and response

Other actions with the object