Specify the group_by parameters in the URL path, and they are in kebab-case format.

Format

GET /3.0/metrics/{metric_group}/group-by/{dimension}

Example

GET /3.0/metrics/attempts/group-by/geo-city-name

 

• ad-break-id (tag c3.ad.breakId)

• ad-break-index (tag c3.ad.breakIndex)

• ad-campaign-name (tag c3.ad.campaignName)

• ad-category (tag c3.ad.category)

• ad-creative-id (tag c3.ad.creativeId)

• ad-creative-name (tag c3.ad.creativeName)

• ad-creative-type (tag c3.ad.creativeType)

• ad-day-part (tag c3.ad.dayPart)

• ad-deal-id (tag c3.ad.dealId)

• ad-fallback-index (tag c3.ad.fallbackIndex)

• ad-first-ad-id (tag c3.ad.firstAdId)

• ad-first-ad-system (tag c3.ad.firstAdSystem)

• ad-first-creative-id (tag c3.ad.firstCreativeId)

• ad-id (tag c3.ad.id)

• ad-is-slate (tag c3.ad.isSlate)

• ad-manager-name (tag c3.ad.adManagerName)

• ad-manager-version (tag c3.ad.adManagerVersion)

• ad-media-file-api-framework (tag c3.ad.mediaFileApiFramework)

• ad-planned-duration (tag c3.ad.plannedDuration)

• ad-position (tag c3.ad.position)

• ad-sequence (tag c3.ad.sequence)

• ad-session-start-event (tag c3.ad.sessionStartEvent)

• ad-stitcher (tag c3.ad.adStitcher)

• ad-system (tag c3.ad.system)

• ad-technology (tag c3.ad.technology)

• ad-type (tag c3.ad.type)

• ad-unit-name (tag c3.ad.unitName)

• ad-video-asset-name (tag c3.ad.videoAssetName)

• advertiser (tag c3.ad.advertiser)

• advertiser-category (tag c3.ad.advertiserCategory)

• advertiser-id (tag c3.ad.advertiserId)

• advertiser-name (tag c3.ad.advertiserName)

• 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

• 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)

 

Error Code Dimensions:

• video-playback-failure-error (for metric video-playback-failures only)

• video-playback-failure-business-error (for metric video-playback-failures-business only)

• video-playback-failure-tech-error (for metric video-playback-failures-tech only)

• video-start-failure-error (for metric video-start-failures only)

• video-start-failure-business-error (for metric video-start-failures-business only)

• video-start-failure-tech-error (for metric video-start-failures-tech only)

• ad-video-start-failure-error (for metric ad-video-start-failures only)

• ad-video-playback-failure-error (for metric ad-video-playback-failures only)

Specify filter parameters in the query string, in snake_case format.

Format:

GET /3.0/metrics/{metric_group}{/group-by/{dimension}}?{filter_dimension_name}={filter_dimension_value}

Example:

GET /3.0/metrics/attempts?device_os=Android

• ad_break_id

• ad_break_index

• ad_campaign_name

• ad_category

• ad_creative_id

• ad_creative_name

• ad_creative_type

• ad_day_part

• ad_deal_id

• ad_fallback_index

• ad_first_ad_id

• ad_first_ad_system

• ad_first_creative_id

• ad_id

• ad_is_slate

• ad_manager_name

• ad_manager_version

• ad_media_file_api_framework

• ad_planned_duration

• ad_position

• ad_sequence

• ad_session_start_event

• ad_stitcher

• ad_system

• ad_technology

• ad_type

• ad_unit_name

• ad_video_asset_name

• advertiser

• advertiser_category

• advertiser_id

• advertiser_name

• app_version

• asn

• asset

• asset_type

• browser_name

• browser_version

• cdn

• cdn_edge_group

• cdn_edge_server

• connection_type

• content_category

• content_meta_affiliate

• content_meta_brand

• content_meta_category_type

• content_meta_channel

• content_meta_content_type

• content_meta_episode_number

• content_meta_genre

• content_meta_genre_list

• content_meta_id

• content_meta_name

• content_meta_season_number

• content_meta_series_name

• content_meta_show_title

• conviva_core_sdk_version

• 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

• isp

• network_connection_type

• platform

• platform_version

• player_name

• player_framework_name

• player_framework_version

• precision_algo_id

• precision_cdn

• precision_rs

• preroll_status

• stream_host

• user_agent

• utm_tracking_code

• video_asset_name

• 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