Tracking Events API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by david.simerly on Jul 31, 2018
Version 9Show Document
  • View in full screen mode

Before using PubMatic APIs, first generate the API Token. For more information, see Getting Started with PubMatic APIs

The Tracking Events API lets you track user engagement for a Creative once it is delivered (if it is provided for the Unified Ad Server).

For more information about UAS Creative Management Services, see Creative Management Services (UAS)

Supported Operations

Method PathHTTP Method TypeDescriptionLink to Definition
/trackingevents/{id}GET

Retrieve the details of a specific Tracking Event for the requested id.

 

The table below lists supported tracking events:

Not all creative types support Tracking Events.

IDTracking Event
1Click Tracking
2Complete
3Creative View
4Custom Click
5First Quartile
6Mid Point
7Start
8Third Quartile
9Impression Tracking
Retrieve the Details of a Tracking Event
/trackingevents/GET

Use this method to retrieve the list of UAS supported tracking events for a creative. See Creative API for the applicable Tracking Event for the supported Creative Type. You can apply supported dimensions, filters, and sorting options to fetch a list of Tracking Events with a specific set of details.

Retrieve a List of Tracking Events

 

Retrieve the Details of a Tracking Event

This API enables you to retrieve the details of a specific Tracking Event.

 

Request

 

Request Headers

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
AuthorizationStringBearer ${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, see Getting Started with PubMatic APIs.

 

Request URL

https://api.pubmatic.com/v1/uas/trackingevents/1

Response

Response Body Parameters

ParameterTypeDescription
idNumericTracking Event Identifier
nameStringName for the creative type
descriptionStringCreative Type description.

 

Sample Response JSON

{
    "id": 1,
    "name": "Image"
    "description": "Image Asset"
}

 

Retrieve a List of Tracking Events

This API lets you retrieve a list of Tracking Events. In the query, you can also apply supported dimensions, filters, and sorting options to fetch a list of Tracking Events with a specific set of details according to your requirements.

See Common Request Query Parameters to learn more about using dimensions, sort, and filter options.

Request

 

Request Headers

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
AuthorizationStringBearer ${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

 

Request URL

https://api.pubmatic.com/v1/uas/trackingevents/?dimensions=id,name&filters=id eq 1

 

Response

Sample Response JSON

Response will contain records matching request and filtering criteria.

 

Error Codes For Tracking Events

Sr. No
Error Codes
Error Message
Description

1.

MISSING_OR_INVALID_PARAMETER

Missing or Invalid entity id [ < Tracking Events Id provided by you > ]

Occurs when a request for Tracking Events details is made with an id that does not exist or is invalid.

 

Unified Ad Server References

 

Version 0.1

 

⇧ Top

Attachments

    Outcomes