Customize a report pack

From the Report Pack, you can customize an existing report pack using filters, data stores, and dimensions or metrics combinations.

Select the report pack from the table and click Edit. You can edit various settings in each of the content panels by clicking its accordion button to reveal them.

  • Basic Details. You can edit the name of the report pack and you can change its status, to activate it.

  • CP codes. The CP code selected here is used for billing and reporting information. Select from the available CP codes or click Create to name and submit a new CP code. You can link to this new CP code and unlink it from the old.

  • Data Sources. This represents the source of the data stream used to collect statistics for a report pack. Select the data source you created during report pack configuration to generate relevant reports, or click Create to configure a new data source on the fly and link your report pack to this new data source, and unlink it from the old. Refer to Configure data source for help. When a data source is created, a data source configuration path and a link to the integration instructions are provided to you. For JavaScript players, an Integration Diagnoser can be launched by passing the HTTP query string "AkamaiAnalytics_debug=1".

  • Data Stores. A data store is a collection of dimensions and metrics stored in a database, that can be used to create reports. Dimensions in a data store are slotted into three information levels: viewer, visit, and play. Custom data stores are built when available dimensions don't fit into the Viewer>Visit>Play drop-down structure. Click Create to build these data stores with metrics and new dimensions and add them to a report pack. Use the report builder to build reports using the customized data store. Refer to Configure a data store for more information.

  • Lookup Tables. A lookup table is used to exercise control over the set of possible values for a dimension. You can import a defined .csv file or enter possible key-value pairs to define a lookup. This displays the dimensions and lookup tables in the Lookup Tables section of the Add Report Pack page. This is useful when you want to map an internally used ID or abbreviated string to what it represents. When creating a lookup table, you can select a dimension and tie the lookup table to it. Refer to Configure a lookup table for more information.

  • Enhanced Standard Reports. Standard reports are equipped with standard dimensions by default. To configure custom dimensions that can be plotted alongside standard dimensions in a custom report, you can categorize them as any one of these information levels: "Viewer," "View," or "Play" based on their properties. See Configure a dimension for more information. Up to two custom dimensions per information level can be configured for standard reports using the report builder interface. If you need more than two custom dimensions per level, you can create a new data store with the additional dimensions. See Configure a data store for more information.

  • Data Filters. Data filters are used to modify data sources to include only qualifying data in reports, and effectively reduce the overall data set that's stored. For example, CP codes in a data source include data for many referrers, but you are only interested in data associated with the referrer foo.com. You could filter foo.com as the referrer to remove all unrelated data, and only generate reports for foo.com.

    Viewer access can be included or excluded by filtering specific data that's fed to the report pack. You can filter based on geography, the URL, or the referrer. See Configure a data filter for more information.

📘

To support UTF-8, non-ASCII characters can be used in data filters and lookup tables as keys and mapped to values or even as values. These are appropriately displayed in the UI.

Configure a data store

When you can't plot a combination of relevant dimensions and metrics to create the custom report you want, you can create a data store by selecting a subset of dimensions and metrics in the data store.

A data store is a logical grouping of metrics and dimensions used to build reports using one or more metrics segmented by one or more dimensions. Data is displayed both as a chart, and a table. For example, you could use "Views" (a standard metric) by geography (a standard dimension). You can then use the report builder to build reports on the custom data store.

To configure a data store:

  1. In the Report Packs tab, select the desired entry and click Edit.

  2. Open the Data Stores content panel.

  3. Click Create.

    📘

    For Server Side Analytics, the Create button provides another option, Create Dimension. See Configure a dimension for instructions.

  4. Enter an easily identifiable Name for the data store. The data store type is displayed by default.

  5. In Description, enter a suitable definition for the data source.

  6. Select the relevant Contract. Typically, there is only a single contract available. If there is more than one, and you're not sure which to choose, contact your account representative.

  7. Select the Group that has the right access to Media Analytics.

  8. In No. of Data Points, specify the maximum number of rows that might be required to store the data store, based on the dimensions selected. If the row limit exceeds the number set, the dimension value in your reports will display as "**".

  9. In Standard Dimensions, select the standard dimension to be paired with a relevant metric.

  10. If you want to use Custom Dimensions, select the custom dimension you want to pair with a relevant metric.

  11. In Metrics, select the metric to be plotted with the primary metric in the report.

  12. In Time Format, select the check box to report data in local time.

  13. Click Submit to complete the configuration.

Configure a lookup table

A lookup table is used to map the values of a dimension to a specific name.

It applies to multiple use cases:

  • You can map an internally used ID or abbreviated string to a more definite value.

  • You can group multiple values into a single name.

  • You can isolate a required set of dimension values from a larger value set. Upload the dimension values you want to the lookup table. An additional '*' entry in the uploaded lookup table represents any insignificant values.

  • You can group a range of numeric metric values to a dimension value range (for example, Start Up Time dimension). You can use this dimension value ranges along with other metric values to plot a histogram. These lookup tables are called "range-based" lookup tables. You can import a defined .csv file or enter possible key-value pairs to define a lookup. In range-based lookup tables, the 'key' column provides the range of lookup values, and the 'value' column can be any number.

To configure a lookup table:

  1. When in the Lookup Tables drop-down, click Edit at the top of the Report Pack Details window.

    A table with dimensions and lookup tables configured for them displays. You can select from it or create a new table.

  2. Click the Create button in the drop-down to begin configuration.

    The Create Lookup Table window displays.

  3. Enter an easily identifiable Name for the lookup table.

  4. Select the desired Type.

    • Range. Click this if you want to use multiple ranges in the existing range lookup tables.

    • Non-Range. Click this to use the key-value option.

  5. In Dimension, select the relevant dimension from the available list.

  6. In Lookup Values, you can do one of the following:

    • Upload CSV. Click Upload CSV to browse to a CSV-format file that contains the mapped values you want to use. You need to create this .csv file in advance.

    • Manually insert lookup values. In Key, enter an identifiable key name. In Value, enter a value for the key name. Click the plus icon beside the value field to include additional values.

    📘

    For Range values, type the range (number-number) in the Key field, and type a value for that range in the Value field.

  7. Click Submit.

Configure a dimension

When the standard dimensions Media Analytics offers don't meet your requirements, you can customize dimensions to generate preferred reports.

  1. From the Enhanced Standard Reports drop-down, click Edit at the top of the Report Pack Details window.

  2. Click Create Dimension.

  3. Enter a unique and identifiable Name for the dimension.

  4. Ensure that the Type field displays what you've selected from the report pack configuration.

  5. Select the desired Level:

    • Play. These dimensions refer to a single title playback event. This also includes attempts to play back the video that resulted in an error. These dimensions can only be combined with play-level metrics.

    • Visit. These dimensions refer to viewer playback activity in a certain duration with one or more titles played during a visit. They can also be used with play metrics.

    • Viewer. These dimensions refer to a viewer's current session and all future sessions. Dimensions at the viewer level can be combined with a single visit and play metrics, but metrics at the viewer level can only be combined with viewer-level dimensions. Restrict the number of distinct values per dimension to 5,000,000.

  6. Use the Based On options to determine the source you want to use to extract dimensions. See Extraction sources, below for more details.

    • Stream URL
    • Stream Referer
    • webpage URL
    • webpage Referer
    • Plug-in setData() calls
  7. Click Submit to complete the configuration.

Extraction sources

All of the Based On source options, except Plug-in setData() calls, can be extracted using the following:

  • Key-value pair in query string. In Key Name, type the key-value pair extracted from the query string. A key-value pair takes the form of sample key=sample value (for example, showname=NightlyNews) and is appended after the '?' parameter which denotes the beginning of the query string portion of a URL (for example, http://foo.com/123.mp4?showname=NightlyNews).

    📘

    Key-value pairs cannot contain the characters ? & / \ % " * ' ` [space] in the name or the value.

  • URI components. Select a component from the URL that you want to use to create a dimension. The format of the components in a URL is as follows: protocol://username:password@hostname:port/directory1/directory2/directory3/filename.extension?

  • String match. Click this option to display the condition fields. In Value, type the value that must be stored for the dimension when the specified "String Match" occurs. In if String, select the appropriate option from the drop-down list, to include or exclude a URI string, that you specify in its text box.

    📘

    Add another condition to include or exclude more conditions in the report pack. For example, if you want to group all analytics for news together, use the value News when a URI contains 'foo.com/news/'.

  • String extraction. In Extract value between, type the text prefix and suffix of the value to be extracted from the URL string. For example, if your URL looks like this: http:// domain.com/foo/dimensionValue/bar/filename. ext?name1=value1, specify the condition as "Extract value between foo/ and /bar". This condition extracts the "dimensionValue". If the prefix or suffix is not constant, you may specify a regular expression rule. See Regular expression filters for more information. Leave the suffix field blank if you want to extract the value through the end of the URL string. Add another condition to extract values if the first condition doesn't extract any values. It's important to note that the Media Analytics only executes the next condition if the first condition does not extract a value.

    📘

    You can now click Test on a sample URL to enter a sample URL and test it to check what it can extract. You can also select a lookup table for dimension values to be used in generated reports.

For Plug-in setData calls, enter the Property Name you want to use to determine values for the report.

A property name is the first parameter in a plug-in setData() call. For example, setData('contentCategory', 'Comedy'). In this example, 'contentCategory' is the property name and 'Comedy' is the category value.

Configure a data filter

Data filters are used to filter the data in your reports and make it fit to your requirements. Only qualifying data is included in reports to effectively reduce the overall data set that Media Analytics stores.

For example, the CP codes in a data source include data for many referrers and you're only interested in data associated with the referrer foo.com. You can filter data to include only foo.com as a referrer to remove all unrelated data and generate reports specifically for foo.com.

  1. When in the Data Filters drop-down, click Edit.

    A table displays with previously configured data filters, their type, and date of creation.

  2. Click the Create button that appears in the drop-down.

  3. In Filter Name, enter a unique name for the filter.

  4. Select the Filter Type:

    • Geography. Click this to include or exclude data based on the number of user request locations. Locations can be chosen by continent, country, and state or province. Select Include or Exclude from the drop-down list to use or ignore data from these locations for analysis.

    • URL. This lets you filter data based on the stream URL. Select Include or Exclude to use or ignore specific data, respectively. Select the appropriate operator for the action from Match Rule, and enter the URL or word you want to include or exclude in Value. Click Add another URL and repeat this process for additional URLs.

    • Referrer. This lets you filter data based on the URL or link that the viewer used to access a stream. It works the same as the URL options, to include or exclude referrer URLs.

    • Other Dimensions. Select this to use other dimensions to filter data. This also works the same as the URL options, to include or exclude these dimensions.

  5. Click Submit.


Did this page help you?