Retrieve List of Available Dimensions
Retrieve a list of available filterable dimensions for the account.
Method
GET
Endpoint
Copy
https://api.conviva.com/insights/3.0/sessions/_meta/references/dimensions
API Responses
200: OK
Example cURL
Copy
curl --request GET \
--url https://api.conviva.com/insights/3.0/sessions/_meta/references/dimensions \
--header 'Accept: application/json'
Example Response
Copy
{
"dimensions": [
{
"name": "App Version",
"query_filter": "?app_version",
"is_custom": false
},
{
"name": "AS Numbers",
"query_filter": "?asn",
"is_custom": false
},
{
"name": "Assets",
"query_filter": "?asset",
"is_custom": false
},
{
"name": "Browser Name",
"query_filter": "?browser_name",
"is_custom": false
},
{
"name": "Browser Version",
"query_filter": "?browser_version",
"is_custom": false
},
{
"name": "CDNs",
"query_filter": "?cdn",
"is_custom": false
},
{
"name": "Last CDN Edge Group",
"query_filter": "?cdn_edge_group",
"is_custom": false
},
{
"name": "Last CDN Edge Server",
"query_filter": "?cdn_edge_server",
"is_custom": false
},
{
"name": "Client id",
"query_filter": "?client_id",
"is_custom": false
},
{
"name": "Content Category",
"query_filter": "?content_category",
"is_custom": false
},
{
"name": "Device Hardware Type",
"query_filter": "?device_hardware_type",
"is_custom": false
},
{
"name": "Device Manufacturer",
"query_filter": "?device_manufacturer",
"is_custom": false
},
{
"name": "Device Marketing Name",
"query_filter": "?device_marketing_name",
"is_custom": false
},
{
"name": "Device Model",
"query_filter": "?device_model",
"is_custom": false
},
{
"name": "Device Name",
"query_filter": "?device_name",
"is_custom": false
},
{
"name": "Device Operating System",
"query_filter": "?device_os",
"is_custom": false
},
{
"name": "Device Operating System Family",
"query_filter": "?device_os_family",
"is_custom": false
},
{
"name": "Device Operating System Version",
"query_filter": "?device_os_version",
"is_custom": false
},
{
"name": "Cities",
"query_filter": "?geo_city_name",
"is_custom": false
},
{
"name": "Continents",
"query_filter": "?geo_continent_name",
"is_custom": false
},
{
"name": "Countries",
"query_filter": "?geo_country_code",
"is_custom": false
},
{
"name": "DMAs",
"query_filter": "?geo_dma",
"is_custom": false
},
{
"name": "States",
"query_filter": "?geo_state_name",
"is_custom": false
},
{
"name": "Is exit before video start",
"query_filter": "?is_exit_before_video_start",
"is_custom": false
},
{
"name": "Is exit during preroll",
"query_filter": "?is_exit_during_preroll",
"is_custom": false
},
{
"name": "ISPs",
"query_filter": "?isp",
"is_custom": false
},
{
"name": "Is video playback failure",
"query_filter": "?is_video_playback_failure",
"is_custom": false
},
{
"name": "Is video playback failure business",
"query_filter": "?is_video_playback_failure_business",
"is_custom": false
},
{
"name": "Is video playback failure tech",
"query_filter": "?is_video_playback_failure_tech",
"is_custom": false
},
{
"name": "Is video start failure",
"query_filter": "?is_video_start_failure",
"is_custom": false
},
{
"name": "Is video start failure business",
"query_filter": "?is_video_start_failure_business",
"is_custom": false
},
{
"name": "Is video start failure tech",
"query_filter": "?is_video_start_failure_tech",
"is_custom": false
},
{
"name": "Platform Version",
"query_filter": "?platform_version",
"is_custom": false
},
{
"name": "Player Framework Name",
"query_filter": "?player_framework_name",
"is_custom": false
},
{
"name": "Player Framework Version",
"query_filter": "?player_framework_version",
"is_custom": false
},
{
"name": "Player name",
"query_filter": "?player_name",
"is_custom": false
},
{
"name": "Session id",
"query_filter": "?session_id",
"is_custom": false
},
{
"name": "Video playback failure business error",
"query_filter": "?video_playback_failure_business_error",
"is_custom": false
},
{
"name": "Video playback failure error",
"query_filter": "?video_playback_failure_error",
"is_custom": false
},
{
"name": "Video playback failure tech error",
"query_filter": "?video_playback_failure_tech_error",
"is_custom": false
},
{
"name": "Video start failure business error",
"query_filter": "?video_start_failure_business_error",
"is_custom": false
},
{
"name": "Video start failure error",
"query_filter": "?video_start_failure_error",
"is_custom": false
},
{
"name": "Video start failure tech error",
"query_filter": "?video_start_failure_tech_error",
"is_custom": false
},
{
"name": "My Example Tag",
"query_filter": "?tag_myExampleTag",
"is_custom": true
}
]
}