Viewing Sample Retention Request & Response

TUNE Reporting API endpoint Reporting Cohort Retention section presents how to create a service request and provides a listing of all available fields including which are recommended for best coverage of results.

This information was taken from the Attribution Analytics Retention Report:

platform_reporting_cohort_retention

Mapping Platform Reporting to API Fields

For a complete listing of all available data points, also referred to as fields, reference the Reporting/Report_Retention data model.

Example TUNE Reporting API Requests and Responses

Count Records: /advertiser/stats/retention/count.json

tune_reporting_api_action_count

URL Request

https://api.mobileapptracking.com/v2/advertiser/stats/retention/count.json?
&group[0]=install_publisher_id
&filter=
&response_timezone=America/Los_Angeles
&start_date=01/29/2015
&end_date=02/05/2015
&interval=year_day
&cohort_type=install
&api_key=YOUR_API_KEY_HERE

JSON Response

{  
   status_code:200,
   response_size:"51",
   data:699   << Record Count
}

Stream Report: /advertiser/stats/retention/find.json

tune_reporting_api_action_find

URL Request

https://api.mobileapptracking.com/v2/advertiser/stats/retention/find.json?
fields=installs,opens,install_publisher_id,install_publisher.name
&group[0]=install_publisher_id
&filter=
&response_timezone=America/Los_Angeles
&start_date=01/24/2015
&end_date=01/31/2015
&interval=year_day
&cohort_type=install
&page=1
&limit=20
&sort[year_day]=asc
&api_key=YOUR_API_KEY_HERE

JSON Response

{  
   status_code:200,
   response_size:"846",
   data:[  
      {  
         data:[  
            {  
               installs:15380,
               opens:5668
            },
            {  
               installs:0,
               opens:664
            },
            {  
               installs:0,
               opens:1178
            },
            {  
               installs:0,
               opens:822
            },
            {  
               installs:0,
               opens:753
            },
            {  
               installs:0,
               opens:701
            },
            {  
               installs:0,
               opens:707
            },
            {  
               installs:0,
               opens:566
            },
            {  
               installs:0,
               opens:150
            }
         ],
         meta:{  
            install_publisher_id:####,
            installs:15380,
            opens:11209,
            year_day:"2015_024",
            install_publisher:{  
               name:"Nam vel metus id dolor"
            }
         }
      },
      {  
         data:[  
            {  
               installs:1370,
               opens:767
            },
            {  
               installs:0,
               opens:100
            },
            {  
               installs:0,
               opens:200
            },
            {  
               installs:0,
               opens:136
            },
            {  
               installs:0,
               opens:136
            },
            {  
               installs:0,
               opens:146
            },
            {  
               installs:0,
               opens:116
            },
            {  
               installs:0,
               opens:99
            },
            {  
               installs:0,
               opens:21
            }
         ],
         meta:{  
            install_publisher_id:####,
            installs:1370,
            opens:1721,
            year_day:"2015_024",
            install_publisher:{  
               name:"Phasellus et lorem non nulla"
            }
         }
      }
   ]
 }

Export Report to Queue: /advertiser/stats/retention/export.json

tune_reporting_api_action_export

URL Request

https://api.mobileapptracking.com/v2/advertiser/stats/retention/export.json?
fields=installs,opens,install_publisher_id,install_publisher.name
&group[0]=install_publisher_id
&filter=
&response_timezone=America/Los_Angeles
&start_date=01/29/2015
&end_date=02/05/2015
&interval=year_day
&cohort_type=install
&sort[year_day]=asc
&api_key=YOUR_API_KEY_HERE

JSON Response

{  
   status_code:200,
   response_size:"98",
   data:{  
      job_id:"dummy####-####-####-####-####dummy" << Job Id of Report in Export Queue
   }
}

Report Export Status and Download from Queue: /advertiser/stats/retention/status.json

tune_reporting_api_action_status

URL Request

https://api.mobileapptracking.com/v2/advertiser/stats/retention/status.json?
job_id=dumm####-####-####-####-####dummy << Job Id of Report in Export Queue

JSON Response

{  
   status_code:200,
   response_size:"388",
   data:{  
      status:"complete",
      percent_complete:100,               << Report Download Link from AWS S3
      url:"https://s3.amazonaws.com/########/#########-####-####-####-#########.csv?response-content-disposition=attachment%3B%20filename%3D%22#########-####-####-####-#########.csv%22 &AWSAccessKeyId=######### &Expires=#########&Signature=#########%2B####%2F####%2B####%3D"
   }
}

The Retention report provided in the TUNE platform automatically excludes testing and debugging data (installs, opens, and events associated with debugging requests or test profiles). This exclusion prevents test data from skewing the retention calculation.

If you are using our Reporting API to export retention results, filter out where debug_mode is greater than 0 or test_profile_id is greater than 0. For example, the following filter for including only real data and excluding test data can be applied on a request for the “Find” endpoint of Retention:

&filter=(test_profile_id = 0 and debug_mode = 0)
Have a Question? Please contact support@tune.com for technical support.