Manage Your Tracking Points With API

Greta
Greta
  • Updated

When you implement a code for a tracking point on a website or web-based app, it becomes active and automatically collects and sends data to Adform.

You need to know the tracking point IDs to manage them in Adform platform. For example, you can then deactivate, delete, reactivate, or export them.

Tip

For more information about the actions you can do with your existing tracking points, see Manage Tracking Points.

With Points API section of the Tracking Points and Filters API, you can retrieve information about all existing tracking points or a specific one to learn about their setup, activity, and then update or delete then if needed.

Authentication

To authenticate and use Adform APIs, your user account must have the necessary permissions and your OAuth client must have the required scopes assigned to it.

To retrieve information about existing tracking points, Adform DSP and Ad Server user account must have this permission assigned by the business account admin:

  • Manage Site Tracking

You also need the following scope assigned to your OAuth client by Adform Support (technical@adform.com):

  • https://api.adform.com/scope/eapi: Grants access to Tracking Points and Filters API.

Tip

If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.

Prerequisites

To retrieve information about existing tracking points with API, use the following IDs in your requests:

ID

Used To

Retrieve From

advertiserId

Specify the advertiser of the tracking point you want to retrieve

Advertisers Management API

campaignId

Specify the campaign of the tracking point you want to retrieve

Campaigns Management API

pointId

Specify the tracking point you want to retrieve

Tracking Points page

Note

Additional IDs might be used, but at least one of the listed ones is required to pass a request.

Workflow

Tip

To learn how to use Adform APIs, read Guide to Using Adform APIs.

To manage tracking points with API:

  1. GET endpoints in Tracking Points and Filters API: To retrieve information about tracking points.

  2. Use Adform platform to manage those tracking points — you can archive and delete them, reactivate them, mark them as exceptions, or export them.

    Note

    Currently, it's not possible to manage tracking points with Adform APIs. To do that, you need to use Adform platform or contact Adform Support (support@adform.com) for help.

Endpoints

[{"api":"Tracking Points and Filters","titles":"Points API"}]

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!