Overview
The Creative Instance Metrics API V4 enables users to specify third-party URLs, enabling notifications of specific ad events.
Use the Creative Instance Metrics API V4 to:
- Create creative instance metrics
- Update creative instance metrics
- Delete creative instance metrics
NOTE
If you cannot configure multiple third-party tracking URLs at the network level, contact your account team.
Uniform Resource Identifiers (URI)
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v4/creative_instances/{creative_instance_id}/creative_metrics |
| Staging | https://api.stg.freewheel.tv/services/v4/creative_instances/{creative_instance_id}/creative_metrics |
Attributes
The requirements of some of the attributes below change based on the settings of other attributes. For example, the input for the event_type attribute can affect the name default value. See event_type Input Settings.
| Parameter | Value | Required? | Notes |
|---|---|---|---|
| event_type | string | Yes | Input for this attribute can affect the name default value. See the table below. |
| name | string | Yes, if event_type input is CUSTOM_CLICK or CUSTOM_COUNTER. | If event_type is not CUSTOM_CLICK or CUSTOM_COUNTER, the name default value is set according to the event_type input. See event_type Input Settings below. |
| url | string | No | No default value is set. |
| tracking_provider_id | integer | No | No default value is set. |
| is_click_through | boolean | Yes, If event_type input is DEFAULT_CLICK_ALL_PLATFORMS | If event_type is set as DEFAULT_CLICK_NON_MOBILE or DEFAULT_CLICK_MOBILE, is_click_through defaults as true. For other event types, the is_click_through default value as false. |
event_type Input Settings
event_type Input SettingsThe input for the event_type attribute can effect the name default value. See below.
event_type Input | name (required or default) |
|---|---|
DEFAULT_IMPRESSION_TRACKER | Set default as defaultImpression |
DEFAULT_CLICK_ALL_PLATFORMS | Set default as defaultClick |
DEFAULT_CLICK_NON_MOBILE | Set default as defaultClick |
DEFAULT_CLICK_MOBILE | Set default as defaultClick |
CUSTOM_CLICK | Name is required. |
CUSTOM_COUNTER | Name is required. |
SURVEY | Set default as survey |
QUARTER_VIEWED_TRACKER | Set default as “firstQuartile |
HALF_VIEWED_TRACKER | Set default as midPoint |
THREE_QUARTER_VIEWED_TRACKER | Set default as thirdQuartile |
COMPLETE | Set default as complete |