Skip to end of metadata
Go to start of metadata

Click Tracker Service

The Click Tracker Service gives you a way to track user clicks on creatives served by third-party ad servers (rather than by AppNexus). Here's how it works:

  1. You use the Click Tracker Service to create a click tracker. The click tracker specifies the line item and publisher to which the click tracker is associated. Generally, it also specifies the target landing page url for the creative (see the redir parameter below for the alternate case). Optionally, it can include the specific placement or payment rule to which it is associated.
  2. You create the url to the click tracker and ask the ad server to use it as the creative's landing page url. The click tracker url must be formatted as http://ib.adnxs.com/clktr?id=12345, where 12345 is the click tracker ID.
  3. When the ad server serves the creative and someone clicks on it, the call first goes to ib.adnxs.com, where AppNexus records the click, and is then redirected to the target landing page.

For specific usage examples, see Examples.

On This Page

Query String Parameters

The following parameters can be passed to AppNexus in the query string of the click tracker url:

Parameter

Description

cachebuster

Prevents the user's browser from caching the click tracker url. This parameter can be populated by the third-party ad server.

ancost

The media cost you paid for the external click. The parameter can be populated by the third-party ad server. It can pass a maximum value of "999999.999999"

redir

The redirect URL. If click_url is not set in the click tracker, you must use this parameter to pass the target landing page url that AppNexus will redirect to once the click has been recorded.

Example

Reporting

You can use the clicktrackers Bulk Reporting Feed to view the data that your external click trackers passed to AppNexus, such as click time, the associated AppNexus objects, and the amount paid for the external click. For an even deeper view of your external clicks, you can use the clicktrackers feed in combination with the Attributed Conversions report.

REST API

Add a click tracker:
POST https://api.appnexus.com/clicktracker?advertiser_id=ADVERTISER_ID
(clicktracker JSON)

Modify a click tracker:
PUT https://api.appnexus.com/clicktracker?id=CLICK_TRACKER_ID
(clicktracker JSON)

View a clicktracker:
GET https://api.appnexus.com/clicktracker?id=CLICK_TRACKER_ID

View multiple clicktrackers by ID using a comma-separated list:
GET https://api.appnexus.com/clicktracker?id=1,2,3

Delete a clicktracker:
DELETE https://api.appnexus.com/clicktracker?id=CLICK_TRACKER_ID

JSON Fields

Field

Type

Description

Default

Required On

id

int

The ID of the click tracker.

Auto-incremented number (i.e. 123)

PUT/DELETE, in query string

member_id

int

Read-only. The ID of the member to which the advertiser belongs.

 

 

advertiser_id

int

The ID of the advertiser that owns the click tracker.

 

POST, in query string

name

string

The name for the click tracker. 

 

POST

code

string

The custom code for the click tracker.

 

 

state

enum

The state of the click tracker. Possible values: "active" or "inactive".

"active"

 

click_url

string

The target landing page for the creative. Once AppNexus has recorded a click on the creative, this is the page that AppNexus will redirect to.

If this field is not set, the target landing page url must be passed as the "redir" parameter in the query string of the click tracker url. See Query String Parameters above for more details.

 

 

publisher

array

The publisher to which the click tracker is associated. See Publisher below for more details.

 

POST

line_item

array

The advertiser line item to which the click tracker is associated. See Line Item below for more details.

 

POST

tag

array

The placement to which the click tracker is associated. See Tag below for more details.

 

 

payment_rule

array

The payment rule to which the click tracker is associated. See Payment Rule below for more details.

 

 

last_modified

timestamp

Read-only. The date and time when the click tracker was last modified.

 

 

Publisher

You can use the Publisher Service to get information about publishers.

Field

Type

Description

id

int

The ID of the publisher to which the click tracker is associated.

name

string

Read-only. The name of the publisher to which the click tracker is associated.

Line Item

You can use the Line Item Service to get information about line items.

Field

Type

Description

id

int

The ID of the line item to which the click tracker is associated.

name

string

Read-only. The name of the line item to which the click tracker is associated.

Tag

You can use the Placement Service to get information about placements.

Field

Type

Description

id

int

The ID of the placement to which the click tracker is associated.

name

string

Read-only. The name of the placement to which the click tracker is associated.

Payment Rule

You can use the Payment Rule Service to get information about payment rules.

Field

Type

Description

id

int

The ID of the payment rule to which the click tracker is associated.

name

string

Read-only. The name of the payment rule to which the click tracker is associated.

Examples

Creating a new click tracker
Updating a click tracker
Viewing click tracker 582
Viewing all click trackers for advertiser 35081