{"__v":8,"_id":"55567c5926e9bc0d0044ec5d","category":{"__v":34,"_id":"555627c5ea5e120d001884ff","pages":["555627c6ea5e120d00188501","55562fbdea5e120d00188526","5556368b150ba30d00f4e0b7","5556590e26e9bc0d0044eb61","55567be0150ba30d00f4e248","55567bf026e9bc0d0044ec55","55567c08150ba30d00f4e24a","55567c14150ba30d00f4e24c","55567c4426e9bc0d0044ec59","55567c501026001900d72abc","55567c5926e9bc0d0044ec5d","55567c9a1026001900d72abf","55567cd9150ba30d00f4e24f","55567ce4150ba30d00f4e251","55567ced26e9bc0d0044ec61","555698d62f6b480d0034d9a4","55e0c386dc6b2e170074f2e3","55e0c5e15087cb1900986c16","55e0f99926f51b0d009b1744","567b35067c40060d0056041d","567b3531ee052b1700dbd9da","56846a5a65976e0d00001c57","5684783bc11c7e0d00aaff71","56847cb55a66610d006eabbd","56848a0cf72e9e0d00e098e5","568ccdf38602880d001ce230","569431fcd8c04d1700e5ae05","569ebe1ad233620d007055fb","569edd718f6d4b0d00f13b91","56aa5c3d13a69a0d00a77a09","56aa6eda4d38401900199f7a","56c7a7d5f9aa3b0d00c8457b","56d0ab1440d36e1d00bc143b","56ec9c5a493ce620008ea4c8"],"project":"555627c4ea5e120d001884fb","version":"555627c4ea5e120d001884fe","reference":false,"createdAt":"2015-05-15T17:07:17.512Z","from_sync":false,"order":0,"slug":"design","title":"Design Studio"},"project":"555627c4ea5e120d001884fb","user":"55562799ea5e120d001884f8","version":{"__v":10,"_id":"555627c4ea5e120d001884fe","project":"555627c4ea5e120d001884fb","hasDoc":true,"hasReference":true,"createdAt":"2015-05-15T17:07:16.918Z","releaseDate":"2015-05-15T17:07:16.918Z","categories":["555627c5ea5e120d001884ff","55562a5526e9bc0d0044ea47","555653821026001900d72a3c","5556685c1026001900d72a85","5556687626e9bc0d0044ec04","555668821026001900d72a87","55566892150ba30d00f4e206","555668b826e9bc0d0044ec05","55e0fb6026f51b0d009b1746","567b3b3017368a0d009a6e54"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"createdAt":"2015-05-15T23:08:09.844Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":20,"body":"* [Basics](#basics)\n* [Debugger Controls](#debugger-controls)\n* [Preview Popup](#preview-popup)\n* [Session Header](#session-header)\n* [Events Table](#events-table)\n* [Table Controls](#table-controls)\n* [Event Data and Details](#event-data-and-details) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Basics\"\n}\n[/block]\n  * **Test metrics** for any ad placement or base ad.\n  * **View events** in real-time as you interact with an ad preview.\n  * **See detailed data** for each tracked event, including event type, subtype, mode and context.\n  * **Filter event data** to see only the events you want.\n  * **View event relationships** with triggers, contexts, and sequence numbers.\n  * **View session information**, including timestamp, user agent, and location.\n\nThe Metrics Debugger allows you to test how your ad tracks metrics. To access the Metrics Debugger, click the *Debug* button in the Traffic Module’s Control Bar.\n\nThe Debugger lets you interact with any ad placement, and view the events that are tracked as you do so. This is especially useful for component developers, who need to make sure that their component is tracking events correctly. However, it is useful for ad developers as well, helping them better understand what information their ad tracks.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Debugger Controls\"\n}\n[/block]\nThe Metrics Debugger places several items in the Control Bar that are absent in the [Placement Manager](doc:design-studio-managing-placements) view. These are:\n  * **Placement dropdown:** The dropdown on the left side includes a choice for each placement that has been created via the [Placement Manager](doc:design-studio-managing-placements) along with a choice titled *Base Ad*.\n  * **Preview button:** Click this to launch a popup with a preview of the base ad or placement that you selected in the Placement dropdown.\n  * **Notations button:** Toggles whether or not *Notation* type events are displayed in the Events Table. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Preview Popup\"\n}\n[/block]\nThe preview popup launches when you click the *Preview* button, displaying the base ad or placement selected in the *Placement* dropdown. Interact with the placement in the Preview Popup, and see the events triggered by your interactions in the [Events Table](#events-table).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Session Header\"\n}\n[/block]\nThe session header appears at the top of the [Events Table](#events-table), just under the control bar. It contains some useful information about the current debugging session.\n  * **Session ID:** The unique 32-digit hexadecimal identifier for this session.\n  * **Variant:** The name of the ad variant in the preview (for A/B testing only).\n  * **Origin:** Your approximate location, based on your IP address.\n  * **Remote IP:** Your IP address.\n  * **User Agent:** Information about your environment, such as the OS and browser.\n  * **URL:** The URL of the page where this preview ad impression is running.\n  * **Date:** Today’s date. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Events Table\"\n}\n[/block]\nThe events table is the main focus of the Metrics Debugger. It lists the events that happen to the ad in the [Preview Popup](#preview-popup) in order of occurrence, along with key information about each event. The table is interactive – clicking various items has an effect. See below for an overview of each table column. Select an event in the table to view its [Event Data and Details.](#event-data-and-details) \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Column Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Click Behavior\",\n    \"0-0\": \"Type\",\n    \"0-1\": \"The high-level category that this event falls into. Flite ads log events of four Types: Impression, Interaction, Content, and Notation.\",\n    \"0-2\": \"Filter the event table to show only events of this type.\",\n    \"1-0\": \"Subtype\",\n    \"1-1\": \"This is a refinement of the event’s Type, categorizing it more precisely. For instance, Interactions have many different subtypes depending on how the user interacted with the ad – Hover, Scroll, Control, Navigate, etc.\",\n    \"1-2\": \"Filter the event table to show only events of this subtype.\",\n    \"2-1\": \"This indicates the mechanics of the Interaction – e.g. Click, Drag, Rollover, etc. Keystrokes are not currently tracked – only mouse interactions are.\",\n    \"2-0\": \"Mode (Interactions Only)\",\n    \"2-2\": \"Filter the event table to show only events with this mode.\",\n    \"3-0\": \"Detail\",\n    \"3-1\": \"This gives additional detail about this event. For each event Type and Subtype, the Detail field may mean different things. For video Control Interactions, it is the function of the control (Play, Pause, etc.); for Navigate Interactions, it’s the name of the layer you are navigating to; for Scroll Interactions, it’s the name of the layer being scrolled; etc\",\n    \"3-2\": \"Filter the event table to show only events with the same detail string.\",\n    \"4-0\": \"Component\",\n    \"4-1\": \"The name of the component that logged this event. Many Flite components log their own events. For a list of events logged by each of Flite's built-in components, see the individual documentation for each standard component.\",\n    \"4-2\": \"Filter the event table to show only events logged by this component.\",\n    \"5-0\": \"Context\",\n    \"5-1\": \"The sequence number of the event to which this event is subordinate. For instance, muting and unmuting a video are events that are in the context of a video play event. These events would not be possible, and would have no meaning, if the video was not playing.\",\n    \"5-2\": \"Select the context event in the event table, displaying its details.\",\n    \"6-0\": \"Trigger\",\n    \"6-1\": \"The sequence number of the event that caused this event. For instance a video play Content event may be triggered by a button click Interaction.\",\n    \"6-2\": \"Select the trigger event in the event table, displaying its details.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Table Controls\"\n}\n[/block]\nThere are several controls at the bottom of the [Events Table](#events-table) that allow you to control the table’s behavior.\n  * **Filter box:** Type any text string in this box to automatically filter the table to display only events with that text string. Note that clicking on a *Type, Subtype, Mode, Detail,* or *Component* in the table actually uses this filter box.\n  * **Clear Table button:** This button clears the table, removing all events currently listed there.\n  * **Auto Scroll button:** This button toggles the table auto scroll feature. When auto scroll is on, the table will scroll down automatically as new events are logged, displaying the latest event at all times. When auto scroll is off, the table will not scroll unless you do it manually. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Event Data and Details\"\n}\n[/block]\nThis section appears at the bottom of the Metrics Debugger. It lists the Event Data and Event Details for the event that is currently selected in the Events Table.\n\nEvent Data: This is additional data logged with this event that is specific to this particular event type and subtype.\n\nEvent/Session Details: This is metadata and supporting information that is tracked for each event. The same items are tracked regardless of the event’s type. These are listed below.\n  * **Sequence: **The event's sequence number from the Events Table, identifying which event this is.\n  * **Server Timestamp:** The server-side timestamp for when this event occurred, in milliseconds of Unix time (milliseconds elapsed since the start of 1970, UTC).\n  * **Client Timestamp:** The client-side timestamp for when this event occurred, in milliseconds of Unix time (milliseconds elapsed since the start of 1970, UTC).\n  * **Session ID:** The unique 32-digit hexadecimal identifier for this session.\n  * **URL:** The URL of the page where this preview ad impression is running.\n  * **User Agent:** Your browser’s user agent string. This includes information about your environment, OS, browser, etc.\n  * **Language:** Your locale and language.\n  * **Component ID:** The ID of the component that logged this event. Many Flite components log their own events. For a list of events logged by each of Flite's built-in components, see the individual documentation for each standard component.\n  * **Component:** The name of the component that logged this event.\n  * **Remote IP:** Your IP address.\n  * **Latitude/Longitude:** Your latitude and longitude, based on your IP address.\n  * **Country Code:** Your two-letter country code. See here for a full list of country codes.\n  * **Region:** Your region code; for the US and Canada, this is the 2-letter abbreviation of the user’s state/province (see here for list); for other nations, this is a numerical code corresponding to a particular region/province (see here for list).\n  * **City:** Your city.","excerpt":"","slug":"design-studio-metrics-debugger","type":"basic","title":"Metrics Debugger"}

Design Studio

Campaign Studio

Report Studio

Metrics

Flite Console

Ad Ops

Component Studio

Metrics Debugger

* [Basics](#basics) * [Debugger Controls](#debugger-controls) * [Preview Popup](#preview-popup) * [Session Header](#session-header) * [Events Table](#events-table) * [Table Controls](#table-controls) * [Event Data and Details](#event-data-and-details) [block:api-header] { "type": "basic", "title": "Basics" } [/block] * **Test metrics** for any ad placement or base ad. * **View events** in real-time as you interact with an ad preview. * **See detailed data** for each tracked event, including event type, subtype, mode and context. * **Filter event data** to see only the events you want. * **View event relationships** with triggers, contexts, and sequence numbers. * **View session information**, including timestamp, user agent, and location. The Metrics Debugger allows you to test how your ad tracks metrics. To access the Metrics Debugger, click the *Debug* button in the Traffic Module’s Control Bar. The Debugger lets you interact with any ad placement, and view the events that are tracked as you do so. This is especially useful for component developers, who need to make sure that their component is tracking events correctly. However, it is useful for ad developers as well, helping them better understand what information their ad tracks. [block:api-header] { "type": "basic", "title": "Debugger Controls" } [/block] The Metrics Debugger places several items in the Control Bar that are absent in the [Placement Manager](doc:design-studio-managing-placements) view. These are: * **Placement dropdown:** The dropdown on the left side includes a choice for each placement that has been created via the [Placement Manager](doc:design-studio-managing-placements) along with a choice titled *Base Ad*. * **Preview button:** Click this to launch a popup with a preview of the base ad or placement that you selected in the Placement dropdown. * **Notations button:** Toggles whether or not *Notation* type events are displayed in the Events Table. [block:api-header] { "type": "basic", "title": "Preview Popup" } [/block] The preview popup launches when you click the *Preview* button, displaying the base ad or placement selected in the *Placement* dropdown. Interact with the placement in the Preview Popup, and see the events triggered by your interactions in the [Events Table](#events-table). [block:api-header] { "type": "basic", "title": "Session Header" } [/block] The session header appears at the top of the [Events Table](#events-table), just under the control bar. It contains some useful information about the current debugging session. * **Session ID:** The unique 32-digit hexadecimal identifier for this session. * **Variant:** The name of the ad variant in the preview (for A/B testing only). * **Origin:** Your approximate location, based on your IP address. * **Remote IP:** Your IP address. * **User Agent:** Information about your environment, such as the OS and browser. * **URL:** The URL of the page where this preview ad impression is running. * **Date:** Today’s date. [block:api-header] { "type": "basic", "title": "Events Table" } [/block] The events table is the main focus of the Metrics Debugger. It lists the events that happen to the ad in the [Preview Popup](#preview-popup) in order of occurrence, along with key information about each event. The table is interactive – clicking various items has an effect. See below for an overview of each table column. Select an event in the table to view its [Event Data and Details.](#event-data-and-details) [block:parameters] { "data": { "h-0": "Column Name", "h-1": "Description", "h-2": "Click Behavior", "0-0": "Type", "0-1": "The high-level category that this event falls into. Flite ads log events of four Types: Impression, Interaction, Content, and Notation.", "0-2": "Filter the event table to show only events of this type.", "1-0": "Subtype", "1-1": "This is a refinement of the event’s Type, categorizing it more precisely. For instance, Interactions have many different subtypes depending on how the user interacted with the ad – Hover, Scroll, Control, Navigate, etc.", "1-2": "Filter the event table to show only events of this subtype.", "2-1": "This indicates the mechanics of the Interaction – e.g. Click, Drag, Rollover, etc. Keystrokes are not currently tracked – only mouse interactions are.", "2-0": "Mode (Interactions Only)", "2-2": "Filter the event table to show only events with this mode.", "3-0": "Detail", "3-1": "This gives additional detail about this event. For each event Type and Subtype, the Detail field may mean different things. For video Control Interactions, it is the function of the control (Play, Pause, etc.); for Navigate Interactions, it’s the name of the layer you are navigating to; for Scroll Interactions, it’s the name of the layer being scrolled; etc", "3-2": "Filter the event table to show only events with the same detail string.", "4-0": "Component", "4-1": "The name of the component that logged this event. Many Flite components log their own events. For a list of events logged by each of Flite's built-in components, see the individual documentation for each standard component.", "4-2": "Filter the event table to show only events logged by this component.", "5-0": "Context", "5-1": "The sequence number of the event to which this event is subordinate. For instance, muting and unmuting a video are events that are in the context of a video play event. These events would not be possible, and would have no meaning, if the video was not playing.", "5-2": "Select the context event in the event table, displaying its details.", "6-0": "Trigger", "6-1": "The sequence number of the event that caused this event. For instance a video play Content event may be triggered by a button click Interaction.", "6-2": "Select the trigger event in the event table, displaying its details." }, "cols": 3, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "Table Controls" } [/block] There are several controls at the bottom of the [Events Table](#events-table) that allow you to control the table’s behavior. * **Filter box:** Type any text string in this box to automatically filter the table to display only events with that text string. Note that clicking on a *Type, Subtype, Mode, Detail,* or *Component* in the table actually uses this filter box. * **Clear Table button:** This button clears the table, removing all events currently listed there. * **Auto Scroll button:** This button toggles the table auto scroll feature. When auto scroll is on, the table will scroll down automatically as new events are logged, displaying the latest event at all times. When auto scroll is off, the table will not scroll unless you do it manually. [block:api-header] { "type": "basic", "title": "Event Data and Details" } [/block] This section appears at the bottom of the Metrics Debugger. It lists the Event Data and Event Details for the event that is currently selected in the Events Table. Event Data: This is additional data logged with this event that is specific to this particular event type and subtype. Event/Session Details: This is metadata and supporting information that is tracked for each event. The same items are tracked regardless of the event’s type. These are listed below. * **Sequence: **The event's sequence number from the Events Table, identifying which event this is. * **Server Timestamp:** The server-side timestamp for when this event occurred, in milliseconds of Unix time (milliseconds elapsed since the start of 1970, UTC). * **Client Timestamp:** The client-side timestamp for when this event occurred, in milliseconds of Unix time (milliseconds elapsed since the start of 1970, UTC). * **Session ID:** The unique 32-digit hexadecimal identifier for this session. * **URL:** The URL of the page where this preview ad impression is running. * **User Agent:** Your browser’s user agent string. This includes information about your environment, OS, browser, etc. * **Language:** Your locale and language. * **Component ID:** The ID of the component that logged this event. Many Flite components log their own events. For a list of events logged by each of Flite's built-in components, see the individual documentation for each standard component. * **Component:** The name of the component that logged this event. * **Remote IP:** Your IP address. * **Latitude/Longitude:** Your latitude and longitude, based on your IP address. * **Country Code:** Your two-letter country code. See here for a full list of country codes. * **Region:** Your region code; for the US and Canada, this is the 2-letter abbreviation of the user’s state/province (see here for list); for other nations, this is a numerical code corresponding to a particular region/province (see here for list). * **City:** Your city.