tracingPoint

Get a list of action tracing points.

Request format

Note

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=tracingPoint
  & [actionObjectID=<integer>]
  & [advertiserID=<integer>]
  & [categoryID=<integer>]
  & [templateTypeID=<integer>]
  & [userID=<integer>]
  & [referrer=<string>]
  & [campaignID=<integer>]

`actionObjectID`	Get a list from only one object with the specified ID. If this parameter is used, the remaining optional parameters are ignored.
`advertiserID`	Advertiser ID. See also: Add an advertiser. Get a list of advertisers.
`categoryID`	ID of the category to which the audience that interacts with the action tracing point will be labeled into. Acceptable values: `0`: Category not specified. `N`, where N is the category ID. Default value: `0`.
`templateTypeID`	Template type ID. To learn more about template types, see Referer templates. Acceptable values: `0`: Standard. `1`: POSIX.2. Default value: `0`.
`userID`	IDentifier.
`referrer`	URL template for comparing with the website page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted. Sample entry: For the standard template: `⃰site.com/index.php` For POSIX.2: `homer-simpson-tv\.blog4ever\.com\|forum\.rojadirecta\.org\| ^hidan\.eklablog\.com.٭\|^aniworld\.spb\.ru\/.٭\/adfox\/. ٭s$` An entry can contain Russian and Latin letters, numbers, and any special characters.
`campaignID`	Campaign ID. See also: Get a list of campaigns.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <objectID>{integer}</objectID>
    <advertiserID>{integer}</advertiserID>
    <userID>{integer}</userID>
    <objectName>{string}</objectName>
    <weight>{integer}</weight>
    <categoryID>{integer}</categoryID>
    <templateTypeID>{integer}</templateTypeID>
    <objectReferrer>{string}</objectReferrer>
    <objectDescription>{string}</objectDescription>
    <counterPostView>{integer}</counterPostView>
    <counterPostViewToday>{integer}</counterPostViewToday>
    <counterPostClick>{integer}</counterPostClick>
    <counterPostClickToday>{integer}</counterPostClickToday>
    <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).
`objectID`	Unique ID of the action point.
`advertiserID`	Advertiser ID.
`userID`	IDentifier.
`objectName`	Name of the action tracing point.
`weight`	Action point weight.
`categoryID`	Category ID.
`templateTypeID`	Template type ID. Acceptable values: `0`: Standard. `1`: POSIX.2.
`objectReferrer`	URL template for comparing with the website page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted.
`counterPostView`	PostView counter data over the entire period.
`counterPostViewToday`	PostView counter data for today.
`counterPostClick`	PostClick counter data over the entire period.
`counterPostClickToday`	PostClick counter data for today.
`dateAdded`	Add date.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <objectID>8309</objectID>
    <advertiserID>226201</advertiserID>
    <userID>5</userID>
    <objectName>point5</objectName>
    <weight>2</weight>
    <categoryID>11564</categoryID>
    <templateTypeID>0</templateTypeID>
    <objectReferrer/>
    <objectDescription/>
    <counterPostView>0</counterPostView>
    <counterPostViewToday>0</counterPostViewToday>
    <counterPostClick>0</counterPostClick>
    <counterPostClickToday>0</counterPostClickToday>
    <dateAdded>2021-07-15</dateAdded>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the tracingPoint object:

URL template for comparing with the website page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted.

Sample entry:

For the standard template:
```
⃰site.com/index.php
```

For POSIX.2:

homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$

An entry can contain Russian and Latin letters, numbers, and any special characters.

Was the article helpful?

template

tracingPoint2