Filtering by Dimensions

 

Only the Publisher Sample Sessions endpoints (video content or ad) support filtering data by dimensions.

Conviva-defined Dimensions

Not all dimensions are available for the account. Availability depends on which dimensions were selected during initial integration. Contact the account manager to access more dimensions.

Use the list of dimensions endpoint to look up the list of available filtering dimensions for the account. Specify filter parameters in the query string.

Format

Copy 
GET /3.0/sessions/{content|ad}?{filter_dimension_name}={filter_dimension_value}

Example

Copy 
GET /3.0/sessions/content?device_os=Android&is_exit_before_video_start=true

Note: Dimension values are case-sensitive.

   

  • app_version (tag c3.app.version)

  • asn

  • asset

  • asset_type (tag c3.asset.type)

  • browser_name

  • browser_version

  • cdn

  • cdn_edge_group

  • cdn_edge_server

  • connection_type (tag c3.device.conn)

  • content_category (tag c3.video.isLive)

  • content_meta_affiliate (tag c3.cm.affiliate)

  • content_meta_brand (tag c3.cm.brand)

  • content_meta_category_type (tag c3.cm.categoryType)

  • content_meta_channel (tag c3.cm.channel)

  • content_meta_content_type (tag c3.cm.contentType)

  • content_meta_episode_number (tag c3.cm.episodeNumber)

  • content_meta_genre (tag c3.cm.genre)

  • content_meta_genre_list (tag c3.cm.genreList)

  • content_meta_id (tag c3.cm.id)

  • content_meta_name (tag c3.cm.name)

  • content_meta_season_number (tag c3.cm.seasonNumber)

  • content_meta_series_name (tag c3.cm.seriesName)

  • content_meta_show_title (tag c3.cm.showTitle)

  • conviva_core_sdk_version (tag c3.cws.clv)

  • customer

  • device_category

  • device_hardware_type

  • device_manufacturer

  • device_marketing_name

  • device_model

  • device_name

  • device_os

  • device_os_family

  • device_os_version

  • geo_city_name

  • geo_continent_name

  • geo_country_code

  • geo_dma

  • geo_postal_code

  • geo_state_name

  • is_ad_requested (boolean)

  • isp

  • network_connection_type

  • platform (tag c3.pt)

  • platform_version (tag c3.pt.ver)

  • player_name (tag c3.player.name)

  • player_framework_name

  • player_framework_version

  • precision_algo_id (tag c3.go.algoid)

  • precision_cdn (tag c3.de.cdn)

  • precision_rs (tag c3.de.rs)

  • preroll_status

  • stream_host (tag c3.sh)

  • user_agent (tag c3.device.ua)

  • utm_tracking_code (tag c3.cm.utmTrackingUrl)

  • video_asset_name (tag c3.cp.an)

   

  • client_id

  • session_id

   

  • is_exit_before_video_start (boolean)

  • is_exit_during_preroll (boolean)

  • is_video_playback_failure (boolean)

  • is_video_playback_failure_business (boolean)

  • is_video_playback_failure_tech (boolean)

  • is_video_start_failure (boolean)

  • is_video_start_failure_business (boolean)

  • is_video_start_failure_tech (boolean)

   

  • video_playback_failure_business_error

  • video_playback_failure_error

  • video_playback_failure_tech_error

  • video_start_failure_business_error

  • video_start_failure_error

  • video_start_failure_tech_error

Custom Dimension Tags

Filter by custom dimension tags specific to the account. Append the prefix tag_ to the tag name, and use that as the query parameter key.

Assuming that the account has a custom dimension tag called specialContentId. Filter by that dimension using tag_specialContentId as the query paramter key.

Example

Copy 
GET /3.0/sessions/content?tag_specialContentId=1A2B3C4D5E

 

Conviva Sessions API Filtering by Dimensions Conviva Sessions API Filtering by Dimensions Conviva Sessions API Filtering by Dimensions