tracingPoint
Get a list of action tracing points.
Request format
Note
Pagination available.
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>]
|
|
Get a list from only one object with the specified ID. If this parameter is used, the remaining optional parameters are ignored. |
|
|
Advertiser ID. See also: |
|
|
ID of the category to which the audience that interacts with the action tracing point will be labeled into. Acceptable values:
Default value: |
|
|
Template type ID. To learn more about template types, see Referer templates. Acceptable values:
Default value: |
|
|
IDentifier. |
|
|
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:
An entry can contain Russian and Latin letters, numbers, and any special characters. |
|
|
Campaign ID. See also: |
* 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
|
|
Request processing status. If the value is |
|
|
Number of items in the response tree. |
|
|
Item number in the response tree, where N is a number from 0 to rows-1 (where |
|
|
Unique ID of the action point. |
|
|
Advertiser ID. |
|
|
IDentifier. |
|
|
Name of the action tracing point. |
|
|
Action point weight. |
|
|
Category ID. |
|
|
Template type ID. Acceptable values:
|
|
|
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. |
|
|
PostView counter data over the entire period. |
|
|
PostView counter data for today. |
|
|
PostClick counter data over the entire period. |
|
|
PostClick counter data for today. |
|
|
Add date. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=tracingPointResponse:
<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:
- Add an action tracing point.
- Delete an action tracing point.
- Get statistics on action tracing points.
- Edit an action tracing point.
- Get an ad tag for the action tracing point.
Campaign ID.
See also:
Required
Get a list from only one object with the specified ID.
If this parameter is used, the remaining optional parameters are ignored.
Advertiser ID.
See also:
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.
Template type ID. To learn more about template types, see Referer templates.
Acceptable values:
-
0: Standard. -
1: POSIX.2.
Default value: 0.
IDentifier.
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.