Tracking Events API (UAS)

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Aug 29, 2017
Version 7Show Document
  • View in full screen mode

Description

The Tracking Events API enables you to 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, refer to 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 following are supported tracking events:

Note: Tracking event is not supported for all Creative Types.

                                           
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 supported tracking events for Creative by the Unified Ad Server. Please refer to 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

 

Overview

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.
pubTokenString${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/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

Overview

This API enables you to 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.

 

Refer to 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.
pubTokenString${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

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

 

Version 0.1

Attachments

    Outcomes