Create or Reuse a Custom Report

Note:
Error tracking reports only work if error tracking is enabled for your account, and you have an integration with at least one of the following SDKs:
  • HTML5 SDK (Core and Pulse) or any of its derivatives (HTML5 Ad Player and Plugins) for version 2.1.16.23.1 or higher
  • iOS Pulse SDK version 2.3.17.1.0 or higher
  • Android Pulse SDK version 2.3.16.25.0 or higher

No error tracking information is available for direct VAST or VMAP integrations.

Note: The ability to set future dates as end dates needs to be enabled for your account. Contact your Account Manager if you are interested in this functionality.
  1. Open Custom Reporting from the menu Custom Reporting access tab.
  2. Click on the Create a Report button, or click on the ... button of the report you want to reuse, and select Reuse Report.

    The form opens:

    Create a Report page
    Part Name
    1 Report title
    2 Filters. By default, the time filter is entered with the last seven days.
    3 Dimensions. By default, the time dimension with a breakdown by day is selected.
    4 Metrics. By default, the impressions metric is selected.
    5 Warning messages
    6 Create Report
  3. Fill in the following fields:
    1. Title: Insert a descriptive title for the report. For example, Revenue per Category in 2017
    2. Filters: filters can be combined in order to narrow down the data for the report. There is always a time filter enabled and pre-populated with the current week.

      Available filters are:

      Filter Value
      Time

      Each report must have a time filter, which can be set by selecting specific start and end dates from the date picker, or through selecting a predefined time range which is always relative to the current date. For example, if today's date is 16 April 2017 and you select 'this month', then the time range is automatically set to start on 1 April 2017 and end on (including) 16 April 2017.

      Note:

      The following limitations apply to the time filter:

      • You can only select a start date no more than 25 months in the past from the current date and including the current date.
      • The time span cannot be longer than twelve months.
      Note:

      If the refreshable reports functionality is enabled in your account, then you can enter a future date for the end date, which allows you to refresh the report results up until three days after that future date has passed. However, this functionality is only available for reports created through the user interface.

      Setting a future date can be particularly useful when you share a report for campaigns with the associated advertiser, because the advertiser is able to refresh the report results and monitor the progress without the need for an operator in Pulse to share new reports at set intervals.

      For more information on refreshing reports, see Refresh date and button on the View a Custom Report page.

      Note: For static reports, it is recommended to set the end date at least 24 hours in the past from the current time, due to data availability reasons (see Data Availability).
      Device Group Select the device group(s) you would like to filter on.
      Format Type Select the ad format(s) you would like to filter on.
      Flag Select the flag(s) you would like to filter on.
      • No commercials
      • No pre-rolls
      • No mid-rolls
      • No post-rolls
      • No overlays
      • No flags set
      Goal Type Select the goal type(s) you would like to filter on.
      Goal Mode Select the goal mode you would like to filter on. Either Normal or Sponsor.
      Error Code

      Filter on specific error code(s). Possible error codes are:

      Error Code Error Name Description
      0 Unknown error  
      1 Start ad timeout The ad did not start playback within the specified time. Default timeout value is 4 seconds.
      2 Total passback timeout The passback chain did not result in successfully showing an ad, because the pasback timeout expired.
      100 XML parsing error An error in the XML of a third party VAST ticket was found.
      101 VAST schema validation error The third party VAST ticket contains data that is in violation of the VAST schema.
      102 VAST version of response not supported The video player cannot handle the VAST ticket, because its version is not supported.
      200 Ad type not supported The video player received an ad type that it was not expecting and/or cannot display.
      201 Ad linearity error The video player expected a different linearity.
      300 General VAST Wrapper error  
      301 Timeout of VAST URI An error occurred when retrieving a third party URI. Timeout of a VAST URI provided in Wrapper element, or of VAST URI provided in a subsequent Wrapper element. Includes request errors such as invalid URI, unreachable or request timeout for URI, and security or other exceptions related to requesting a VAST URI.
      303 No VAST response No VAST response after one or more Wrappers.
      Note: When using the HTML5 SDK or any of its derivatives, then this error is also reported each time an inventory ad is encountered. An inventory ad is a placeholder where a real ad could have been, but no eligible ad was available in Pulse.
      400 General Linear error The video player is unable to display the linear ad.
      401 File not found Unable to find a media file at the URI.
      402 MediaFile timeout Unable to retrieve the media file within the designated time.
      403 Could not find supported MediaFile Could not find a media file that is supported by the video player, based on the attributes of the MediaFile element.
      405 Problem displaying MediaFile The video player found a media file with a supported type according to the attributes of the MediaFile element and was able to retrieve the file, but could not display the media file. MediaFile may include: unsupported codecs, different MIME type than indicated in @type attribute, unsupported delivery method, and so on.
      500 General NonLinearAds error The video player is unable to display the non-linear ad.
      502 Unable to fetch NonLinearAds / NonLinear resource The resource for the non-linear ad cannot be fetched.
      503 Could not find NonLinear resource with supported type Could not find a resource that is supported by the video player.
      900 Undefined error  
      Content Partner Select the content partner(s) you want to filter on.
      Advertiser Select the advertiser(s) you want to filter on.
      Agency Select the agencies you want to filter on.
      Brand Select the brand(s) you want to filter on.
      Audience Provider

      Select the audience provider you want to filter on. You are only allowed to select one audience provider for filtering.

      Warning: Audience Provider filter must always be used in combination with Audience dimension and the other way around, otherwise your report fails to run.
      Note: Only create reports on audience if you have an integration with an audience data provider. See Pulse Audience Management (PAM) and Ooyala Pulse Audience Management for more information.
      Category Select the category you would like to filter on. You can use the text field to search, or browse through the category tree. You are only allowed to select one category when filtering on category. All child categories of the selected category are automatically included.
      Campaign Select the campaign(s) you would like to filter on.
      Goal Select the goal(s) you would like to filter on.
      Tag Select the tag(s) you want to filter on.
      Geography

      Select the countries, regions, cities, and metro areas you would like to filter on.

      Note: The geographical data is strictly hierarchical. This implies that when you select a country, all of its regions and cities are automatically included, or when you select a region, all of its cities are automatically included.

      A text field is available for each filter, except the time filter, to help you search for specific values. When you enter three or more characters, suggestions appear that match the entered text. For example:

      Campaign Filter
    3. Dimensions: dimensions can be combined in order to create different breakdowns of data. A maximum of eight dimensions can be selected. The order of the dimensions influences how the data is broken down. For each selected dimension, you can also specify to sort in ascending or descending order. Available dimensions are:
      Dimension Description and Options
      Time For the time dimension, you have a further option to break down the data for each:
      • Year
      • Month
      • Day
      • Hour

      This dimension is selected by default with a breakdown by day.

      Ad The ad.
      Advertiser The advertiser associated with a campaign.
      Agency The agency associated with a campaign.
      Audience

      Select this dimension to break down the data based on the segments from the selected audience data provider. The resulting column contains the segment key and value in the following format: <segment key>: <segment value>. For example: Age Group: 18-25.

      Warning: Audience Provider filter must always be used in combination with Audience dimension and the other way around, otherwise your report fails to run.
      Warning: Tag and Audience dimensions cannot be used together in the same report, because the report result cardinality could be too high and surpass the 100000 row limit for Custom Reporting..
      Note: Only create reports on audience if you have an integration with an audience data provider. See Pulse Audience Management (PAM) and Ooyala Pulse Audience Management for more information.
      Brand The brand associated with a campaign.
      Campaign The ad's campaign.
      Category
      When selecting the category dimension, you can also select to which level in the tree you want to break down the data. Breakdown of data based on category is limited to:
      • five levels in the category tree, where the first level corresponds to the category selected in the filter or the root category of your account, in case it is not set in the filter.
      • maximum the seventh level of the category tree, counting the root category as the first level.
      For example, your account category tree looks as follows:
      • Root Category
        • Sports
          • Football
          • Basketball
        • TV Shows
          • Kids Shows
          • Reality Shows
            • Idol
              • Idol Season 1
              • Idol Season 2
            • Masterchef
        • ...

      You select to filter on TV Shows and set Category as a dimension with 3 levels breakdown. The report breakdown looks as follows:

      Category 1 Name* Category 2 Name Category 3 Name Metric Name
      TV Shows undefined** undefined Direct count*** for selected metric for TV Shows category.
      TV Shows Kids Shows undefined Direct count for selected metric for Kids Shows category.
      TV Shows Reality Shows Idol Total count**** for selected metric for Idol category and all its child categories, which are Idol Season 1 and Idol Season 2.
      TV Shows Reality Shows Masterchef Direct count for selected metric for Masterchef category.
      Note:

      *The category column names correspond to the levels the categories represent in the category tree. The root category is marked 'Category 0'. All level one categories are marked 'Category 1', all level two categories are marked 'Category 2', and so on. As the selected category in our example is level one in the category tree, its column name is 'Category 1'.

      **When breaking down categories to multiple levels, each category is assigned a row based on its level. When a metric is recorded for a category of a higher level than what the report reaches, the remaining levels are marked as 'undefined'.

      ***Direct count is displayed for categories that do not have any more levels for breaking down the data.

      ****Total count is displayed for categories that have more levels, but the report does not reach them. In that case, child categories are included in the metric count.

      City The city targeted by a specific campaign or goal.
      Content ID

      The ID of the content where ads were served.

      Note:

      Content IDs are available for reporting in Pulse from March 7, 2018, if you are sending this information to Pulse in your integration(s) through:

      • the content ID parameter in the content metadata object, when using the Pulse SDKs, HTML5 Ad Player or HTML5 Pulse SDK derived plugins, or
      • the content ID parameter, when using direct VAST or VMAP requests.
      Content Partner The content partner targeted by a specific campaign or goal.
      Country The country targeted by a specific campaign or goal.
      Custom Ad ID

      The custom ID entered for an ad.

      Note: The custom ad ID is a free text field, which means that the values may not be unique or even present for each ad.
      Device Group The device group indicates which devices were targeted by a specific campaign or goal. For example, "Android tablets and phones" could be a device group.
      Error Code

      See Error Code under Filters for the possible error codes.

      To create meaningful reports, you must always use the Error Code dimension in combination with the Error metric. You can also report on error counts for the following dimensions:
      • Campaign
      • Goal
      • Ad
      • Device Group
      • Geography (Country, Region, City and Metro Area)
      • Format Type
      • Category
      • Tag
      Flag The flags used in Pulse to mark and remove monetisation from specific content items. Specified by the f request parameter in an ad request to Pulse.
      Format Type Ad format type, like "Pre-roll", "Mid-roll", and so on.
      Goal The ad's goal.
      Goal Mode The mode of a goal, which can be either Normal or Sponsor.
      Goal Type The goal's type, like "Impressions", "Click throughs", "Share of Voice (%)", and so on.
      Metro Area The metro area targeted by a specific campaign or goal.
      Region The region targeted by a specific campaign or goal.
      Tag

      Text representing the tags.

      Warning: Tag and Audience dimensions cannot be used together in the same report, because the report result cardinality could be too high and surpass the 100000 row limit for Custom Reporting..
    4. Metrics: select the metrics you want to see in the report. These are the available metrics for Custom Reporting:
      Metric Description and Options
      Impressions Selected by default. The amount of successfully shown ads. Success is reported as soon as the first frame of the ad is shown.
      Ad 25% The amount of times an ad was viewed to at least 25% completion.
      Ad 50% The amount of times an ad was viewed to at least 50% completion.
      Ad 75% The amount of times an ad was viewed to at least 75% completion.
      Ad Completed The amount of times an ad was viewed to completion.
      Ad Started The amount of time an ad was started, which is the same as impression count for Pulse.
      Click-throughs The amount of times a click-through link was activated.
      Close The amount of times the viewer closed an ad.
      Companion Click-throughs The amount of times a companion banner associated with a linear ad was clicked by a viewer.
      Companion Impressions The amount of times a companion banner associated with a linear ad was successfully shown to the viewer.
      Completion Rate The amount of times an ad was viewed to completion in comparison to the amount of times an ad was started (=Ad Completed/ Impressions).
      Content Start The amount of times that video content was started.
      CTR (Click-through Rate) The proportionate amount of times a click-through link was activated (=click-throughs/times a click-through is available).
      Errors The amount of times errors or a specific error occurred.
      To create meaningful reports, you must always use the Error Code dimension in combination with the Error metric. You can also report on error counts for the following dimensions:
      • Campaign
      • Goal
      • Ad
      • Device Group
      • Geography (Country, Region, City and Metro Area)
      • Format Type
      • Category
      • Tag
      Fill Rate The amount of impressions in comparison to the amount of inventory (=Impression/Inventory).
      Interaction The amount of times that the viewer interacted in a way with an ad.
      Interaction Rate The amount of interactions in comparison to the amount of impressions.
      Inventory

      The amount of opportunities to show an ad.

      Requesting inventory metrics only yields meaningful results for the following dimensions, because they are part of the ad request (directly or indirectly):
      • Device group
      • Format type
      • Tag
      • Content partner
      • Geography dimensions
      • Category
      Revenue The amount of revenue.
      Skip The amount of times an ad was skipped by the viewer.
      Unique Impressions The amount of successfully shown ads to unique viewers, meaning that a viewer who has seen the ad more than once is only counted one time.
      Unique Inventory The amount of opportunities to show an ad to unique viewers.
      View Rate A complex calculation based on quartile view-through rates in comparison to the amount of impressions. This calculation is explained in the following article: How Is View-Through Rate Calculated in Custom Reporting?
  4. Click Create Report to add the report to the queue for generating.
https://help.ooyala.com/sites/all/libraries/dita/en/video-advertising/oadtech/ad_serving/ug/custom_reporting_create_report.html

Was this article helpful?