Overview: iTunes Connect Query Builder

With the iTunes Connect Query Builder, you can better manage the impact of content distributed through Apple’s online stores. In this article, we will discuss the functionality of the iTunes Connect Query Builder, and will then work through an example based on a specific use case. 

IN THIS ARTICLE

1. Query Builder Overview

1
  Custom Query Name (required): Enter a unique metric name for your custom metric. This name will then be the metric title that you will need to select in the Designer tool when building your Databoard. 
2
  Metric (required): Select a metric from your connected iTunes Connect account. This includes metrics like Impressions, In-App Purchases and Sales.  
3
   Dimension (optional): The  dimensions parameter breaks down the metric by common criteria, such as Source Type, Web Referrer or Device. The metric output is recategorized based on the selected dimension value. 

If a query has no  dimension selected as a parameter, the returned custom metric will provide aggregate values, such as total Impressions in the given date range.
4
   Date range (required): To display this metric in the most optimal way, you will need to choose time intervals. Click on the "Date range" field and select the intervals (up to 8) that you want as options when you pull this into the databoard. These will be the only date range options that you have available in the Designer tool when working with this custom metric. 

NOTE: For the "Tasks" Radio Button you can only select one date range, because you are tracking tasks, which due date is set to one specific date range. 
5
  Compare With (optional): Select a date range to compare your previously selected interval to. This date range will be used for "previous line" on line and bar charts, and for calculating percent change. Options are:  None and  Previous period.

6
   Filter by (optional): Within this Query Builder, you can filter results by the selected Metric (#2 above) and/ or Dimension (#3 above). Filters can be combined using AND / OR boolean logic. Filtered queries restrict the rows that are included or excluded in the result. Each row in the result is tested against the filter. If the filter matches, the row is retained. If it doesn't match, the row is dropped.

2. Results

The " Data Preview" section allows you to see all of the values that are being returned in for the query you have created. At the bottom, you can find the total values bolded. To see data previews for different date ranges, click on the different tabs at the top of the preview.

3. Example

In this example, we'll work through one basic use case that highlights how to use the Query Builder to access and filter iTunes Connect data.

Let's say we want to see the number of Impressions for the current month, split up by the Web Referrers. However, rather than viewing data for all Web Referrers we only want to report on Google Web Referrers.

1
 First, we'll create a name for the custom query. For this example, we will name it "Impressions by Web Referrer (Google)".
2
     We're interested in reporting on the number of Impressions, so we'll select the "Impressions" metric from the dropdown list. 
3
 We want to split up the Impressions based on the Web Referrer. So, we will select "Web Referrer" as the Dimension.  
4
    Since we want to report on data for the month, we'll need to be sure to include the Date Range selection for "This Month." We also included Last 30 Days, Last 90 Days and Last Month in our custom metric to give us options for viewing this data in the future. 
5

 Finally, we want to limit results so we're only viewing Google Web Referrers. In order to do this, we'll add a Filter to only retain data if the Dimension (Web Referrer) contains "google" in the returned value. 

6
 When we run the query, we get the total number of Impressions for the month, split up based on the Web Refferer. The only Web Referrers returned are those that contain the string "google," due to the Filter we added to our custom metric.

When you're confident in the query you built, click " Save query." This creates a new custom metric in Databox that is accessible in the Designer tool. 

Let's move over to the Designer to pull this custom metric onto a Databoard. After you select the correct iTunes Connect Data Source in the righthand Property Manager, you'll be able to find your new custom metric in the  Custom tab of the metric dropdown list. 

This will now populate the visualization type on your Databoard with the custom query values.

Still need help? Contact Us Contact Us

Related Articles