tune_reporting.api package

Submodules

tune_reporting.api.advertiser_report_actuals module

TUNE Management API ‘/advertiser/stats/’

class tune_reporting.api.advertiser_report_actuals.AdvertiserReportActuals[source]

Bases: tune_reporting.base.endpoints.reports_actuals_endpoint_base.ReportsActualsEndpointBase

TUNE Management API endpoint ‘/advertiser/stats/’

The constructor.

tune_reporting.api.advertiser_report_clicks module

TUNE Management API ‘/advertiser/stats/clicks/’

class tune_reporting.api.advertiser_report_clicks.AdvertiserReportClicks[source]

Bases: tune_reporting.base.endpoints.reports_logs_endpoint_base.ReportsLogsEndpointBase

TUNE Management API endpoint ‘/advertiser/stats/clicks’

The constructor.

tune_reporting.api.advertiser_report_cohort module

TUNE Management API ‘/advertiser/stats/ltv/’

class tune_reporting.api.advertiser_report_cohort.AdvertiserReportCohort[source]

Bases: tune_reporting.base.endpoints.reports_insights_endpoint_base.ReportsInsightEndpointBase

TUNE Management API controller ‘advertiser/stats/ltv’

The constructor.

export(start_date, end_date, cohort_type, cohort_interval, aggregation_type, fields, group, filter=None, response_timezone=None)[source]

Places a job into a queue to generate a report that will contain records that match provided filter criteria, and it returns a job identifier to be provided to action /export/download.json to download completed report.

param str start_date:
 YYYY-MM-DD HH:MM:SS
param str end_date:
 YYYY-MM-DD HH:MM:SS
param str cohort_type:
 Cohort types - click, install
param str cohort_interval:
 Cohort intervals - year_day, year_week, year_month, year
param str aggregation_type:
 Aggregation types - cumulative, incremental
param str group:
 Group results using this endpoint’s fields.
param str fields:
 No value returns default fields, “*” returns all available fields, or provide specific fields.
param str filter:
 Filter the results and apply conditions that must be met for records to be included in data.
param str response_timezone:
 Setting expected timezone for data. Default is set by account.
return:(TuneManagementResponse)
fetch(job_id, verbose=False, sleep=10)[source]

Helper function for fetching report upon completion. Starts worker for polling export queue.

param str job_id:
 Provided Job Identifier to reference requested report on export queue.
param bool verbose:
 Debug purposes only to view progress of job on export queue.
param int sleep:
 Polling delay between querying job status on export queue.
return:(TuneManagementResponse)
find(start_date, end_date, cohort_type, cohort_interval, aggregation_type, fields, group, filter=None, limit=None, page=None, sort=None, format=None, response_timezone=None)[source]

Finds all existing records that match filter criteria and returns an array of found model data.

param str start_date:
 YYYY-MM-DD HH:MM:SS
param str end_date:
 YYYY-MM-DD HH:MM:SS
param str cohort_type:
 Cohort types: click, install
param str cohort_interval:
 Cohort intervals: year_day, year_week, year_month, year
param str aggregation_type:
 Aggregation types: cumulative, incremental
param str group:
 Group results using this endpoint’s fields.
param str filter:
 Filter the results and apply conditions that must be met for records to be included in data.
param str fields:
 No value returns default fields, “*” returns all available fields, or provide specific fields.
param int limit:
 Limit number of results, default 10.
param int page:
 Pagination, default 1.
param array sort:
 Sort by field name, ASC (default) or DESC
param str timestamp:
 Set to breakdown stats by timestamp choices: hour, datehour, date, week, month.
param str response_timezone:
 Setting expected timezone for data. Default is set by account.
return:(TuneManagementResponse)

tune_reporting.api.advertiser_report_event_items module

TUNE Management API ‘/advertiser/stats/event/items/’

class tune_reporting.api.advertiser_report_event_items.AdvertiserReportEventItems[source]

Bases: tune_reporting.base.endpoints.reports_logs_endpoint_base.ReportsLogsEndpointBase

Advertiser Stats logs pertaining to event items.

The constructor.

tune_reporting.api.advertiser_report_events module

TUNE Management API ‘/advertiser/stats/events/’

class tune_reporting.api.advertiser_report_events.AdvertiserReportEvents[source]

Bases: tune_reporting.base.endpoints.reports_logs_endpoint_base.ReportsLogsEndpointBase

Advertiser Stats logs pertaining to events.

The constructor.

tune_reporting.api.advertiser_report_installs module

TUNE Management API ‘/advertiser/stats/installs/’

class tune_reporting.api.advertiser_report_installs.AdvertiserReportInstalls[source]

Bases: tune_reporting.base.endpoints.reports_logs_endpoint_base.ReportsLogsEndpointBase

Advertiser Stats logs pertaining to installs.

The constructor.

tune_reporting.api.advertiser_report_postbacks module

TUNE Management API ‘/advertiser/stats/postbacks/’

class tune_reporting.api.advertiser_report_postbacks.AdvertiserReportPostbacks[source]

Bases: tune_reporting.base.endpoints.reports_logs_endpoint_base.ReportsLogsEndpointBase

Advertiser Stats logs pertaining to postbacks.

The constructor.

tune_reporting.api.advertiser_report_retention module

TUNE Management API ‘/advertiser/stats/retention/’

class tune_reporting.api.advertiser_report_retention.AdvertiserReportRetention[source]

Bases: tune_reporting.base.endpoints.reports_insights_endpoint_base.ReportsInsightEndpointBase

TUNE Management API controller ‘advertiser/stats/retention’

The constructor.

export(start_date, end_date, cohort_type, cohort_interval, fields, group, filter=None, response_timezone=None)[source]

Places a job into a queue to generate a report that will contain records that match provided filter criteria, and it returns a job identifier to be provided to action /export/download.json to download completed report.

param str start_date:
 YYYY-MM-DD HH:MM:SS
param str end_date:
 YYYY-MM-DD HH:MM:SS
param str cohort_type:
 Cohort types - click, install
param str cohort_interval:
 Cohort intervals - year_day, year_week, year_month, year
param str fields:
 No value returns default fields, “*” returns all available fields, or provide specific fields.
param str group:
 Group results using this endpoint’s fields.
param str filter:
 Filter the results and apply conditions that must be met for records to be included in data.
param str response_timezone:
 Setting expected timezone for data. Default is set by account.
return:(TuneManagementResponse)
fetch(job_id, verbose=False, sleep=10)[source]

Helper function for fetching report upon completion. Starts worker for polling export queue.

param str job_id:
 Provided Job Identifier to reference requested report on export queue.
param bool verbose:
 Debug purposes only to view progress of job on export queue.
param int sleep:
 Polling delay between querying job status on export queue.
return:(TuneManagementResponse)
find(start_date, end_date, cohort_type, cohort_interval, fields, group, filter=None, limit=None, page=None, sort=None, format=None, response_timezone=None)[source]

Finds all existing records that match filter criteria and returns an array of found model data.

param str start_date:
 YYYY-MM-DD HH:MM:SS
param str end_date:
 YYYY-MM-DD HH:MM:SS
param str cohort_type:
 Cohort types: click, install
param str cohort_interval:
 Cohort intervals: year_day, year_week, year_month, year
param str fields:
 No value returns default fields, “*” returns all available fields, or provide specific fields.
param str group:
 Group results using this endpoint’s fields.
param str filter:
 Filter the results and apply conditions that must be met for records to be included in data.
param int limit:
 Limit number of results, default 10.
param int page:
 Pagination, default 1.
param array sort:
 Sort by field name, ASC (default) or DESC
param str timestamp:
 Set to breakdown stats by timestamp choices: hour, datehour, date, week, month.
param str response_timezone:
 Setting expected timezone for data. Default is set by account.
return:(TuneManagementResponse)

tune_reporting.api.export module

export.py

class tune_reporting.api.export.Export[source]

Bases: tune_reporting.base.endpoints.endpoint_base.EndpointBase

TUNE Management API endpoint ‘/export/’.

The constructor.

download(job_id)[source]

Action ‘download’ for polling export queue for status information on request report to be exported.

param str job_id:
 Job identifier assigned for report export.
return:TuneManagementResponse
fetch(job_id, verbose=False, sleep=60)[source]

Helper function for fetching report upon completion. Starts worker for polling export queue.

param str job_id:
 Job identifier assigned for report export.
param bool verbose:
 For debug purposes to monitor job export completion status.
param int sleep:
 Polling delay for checking job completion status.
return:Document contents
static parse_response_report_url(response)[source]

Helper function for parsing export status response to gather report url

Parameters:response (object) – TuneManagementResponse
Return (str):Report Url
Throws:TuneSdkException

Module contents

tune management api module