Upsight logo Back to top

Traffic

Clicks


traffic_sources/clicks

URL

http://query.kontagent.net/processed/v1/social/traffic_sources/clicks/<data_type>.<data_format>/?api_key=<API KEY>&<other parameters>

Data Output Types

ParameterValuesDescription
data_typeseriesThe output data type.
data_format
  • json
The format of the output data.

Required Parameters

ParameterValuesDescription
api_keyYour Upsight Analytics API key.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • week
  • hour
  • month
  • day
The frequency of data reporting. For example, a time segment by day will return the data on a daily basis between the start and end times specified. A time segment by hour will return the data on an hourly basis between the start and end times specified.

Optional Parameters

ParameterValuesDescription
group_by
  • location:country
  • location:country_abbreviation
  • location:continent
  • location:continent_abbreviation
  • demographic:gender
  • demographic:gender_abbreviation
  • demographic:age_range
The location or demographic group.
source_subtype1 The st1 parameter name as defined by you in the UCC API call.
source_subtype2 The st2 parameter name as defined by you in the UCC API call.
source_subtype3 The st3 parameter name as defined by you in the UCC API call.
source_type
  • ad_buy
  • ad_buy.tlm
  • ad_buy.spruce
  • ad_buy.tbg
  • stream
  • bookmarks
  • canvas_bkmk_top
  • canvas_bkmk_more
  • dashboard
  • dashboard_activity
  • discovery
  • email
  • fdp
  • feedpub
  • feedstory
  • games_friends_apps
  • games_my_recent
  • inr
  • invite
  • nei
  • nf
  • notification
  • ntr
  • partner
  • ts
The source type name as defined by you in the UCC API call.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/traffic_sources/clicks/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 4874]
,['2011-06-12', 8045],
['2011-06-19', 7522],
['2011-06-26', 12443],
['2011-07-03', 40059]]

Install Summary


traffic_sources/installs_summary

URL

http://query.kontagent.net/processed/v1/social/traffic_sources/install_summary/<data_type>.<data_format>/?api_key=<API KEY>&<other parameters>

Data Output Types

ParameterValuesDescription
data_typelistThe output data type.
data_format
  • json
The format of the output data.

Required Parameters

ParameterValuesDescription
api_keyYour Upsight Analytics API key.
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
start_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
One of the following:
group_by
  • location:country
  • location:continent
  • location:continent_abbreviation
  • demographic:gender
  • demographic:gender_abbreviation
  • demographic:age_range
The location or demographic group.
export
  • day
  • week
  • month
  • campaign
  • category
  • content
The export parameter.

Optional Parameters

ParameterValuesDescription
source_type
  • ad
  • partner
  • ad_buy
  • ad_buy.spruce
  • ad_buy.tbg
  • ad_buy.tm
The source type name as defined by you in the UCC API call.
next_group_by
  • day
  • week
  • month
  • campaign
  • category
  • content
The drilldown parameter. Where dimensionN is one of: day, week, month, campaign, category, content. For example, campaign:fb.
sparkline_daysdaysThe sparkline frequency of data reporting. The data on a daily basis between the start and end times specified.
sparkline_end_timeYYYYmmdd_HHMM formatThe sparkline end time element in the time range being queried in the YYYYmmdd_HHMM format.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/traffic_sources/install_summary/list.json/?app_handle=some_app&start_time=20120101_0000&end_time=20120201_0000&source_type=ad&export=category,content

Return:

[{"virality": 0.0,
"viral_installs": 0,
"pageviews": 0,
"monetization1": 0,
"revenue": 0,
"time_on_site_per_session":  "0.0",
"7_day_retention": 0,
"monetization_count1": 0,
"install_conv": 0.0,
"category": "29337064",
"conversion": 0.0,
"1_day_retention": 0,
"page_views_per_session": "0.0",
"installs": 0,  "tos": 0,
"sessions": 0,
"content": "21_24",
"goal_count1": 0,
"goal_count2": 0,
"goal_count3": 0,
"goal_count4": 0, 
"arpu": 0.0,
"retention_day_1": 0,
"retention_day_7": 0,
"clicks": 1},
...
]

Installs


traffic_sources/installs

URL

http://query.kontagent.net/processed/v1/social/traffic_sources/installs/<data_type>.<data_format>/?api_key=<API KEY>&<other parameters>

Data Output Types

ParameterValuesDescription
data_typeseriesThe output data type.
data_format
  • json
The format of the output data.

Required Parameters

ParameterValuesDescription
api_keyYour Upsight Analytics API key.
start_timeYYYYmmdd_HHMM formatThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMM formatThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • week
  • hour
  • month
  • day
The frequency of data reporting. For example, a time segment by day will return the data on a daily basis between the start and end times specified. A time segment by hour will return the data on an hourly basis between the start and end times specified.
group_by
  • location:country
  • location:country_abbreviation
  • location:continent
  • location:continent_abbreviation
  • demographic:gender
  • demographic:gender_abbreviation
  • demographic:age_range
The location or demographic group.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/traffic_sources/installs/series.json/?api_key=c3fb72a38427424290dacfded023b43e&start_time=20121101_0000&end_time=20121130_0000&time_segment=week&group_by=location:country

Return:

[
    [
        "Afghanistan",
        0
    ],
    [
        "Aland Islands",
        0
    ],
    [
        "Albania",
        0
    ],
    [
        "Algeria",
        0
    ],
. . . 
    [
        "Yemen",
        0
    ],
    [
        "Zambia",
        0
    ],
    [
        "Zimbabwe",
        0
    ]
]

Summary


traffic_sources/summary

URL

http://query.kontagent.net/processed/v1/social/traffic_sources/summary/<data_type>.<data_format>/?api_key=<API KEY>&<other parameters>

Data Output Types

ParameterValuesDescription
data_typelistThe output data type.
data_format
  • json
The format of the output data.

Required Parameters

ParameterValuesDescription
api_keyYour Upsight Analytics API key.
start_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
source_type
  • ad
  • location:continent
  • location:continent_abbreviation
  • demographic:gender
  • demographic:gender_abbreviation
  • demographic:age_range

Optional Parameters

ParameterValuesDescription
source_subtype1The st1 parameter name as defined by you in the UCC API call.
source_subtype2The drilldown parameter. Where dimensionN is one of: day, week, month, campaign, category, content. For example, campaign:fb.
sparkline_daysdaysThe sparkline frequency of data reporting. The data on a daily basis between the start and end times specified.
sparkline_end_timeYYYYmmdd_HHMM formatThe sparkline end time element in the time range being queried in the YYYYmmdd_HHMM format.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/traffic_sources/summary/list.json/?start_time=20110605_0000&end_time=20120125_0000&app_handle=sample&source_type=ad

Return:

[{"viral_installs": 5,
"monetization_count1": 0,
"pageviews": 29876,
"monetization1": 0,
"1_day_retention": 0,
"sessions": 4380,
"installs": 0,
"tos": 4554077,
"clicks_by_day": [0, 0, 0, 0, 0, 0, 0],
"time_on_site_per_session": "1039.7",
"page_views_per_session": "6.8",
"goal_count1": 0,
"goal_count2": 0,
"goal_count3": 0,
"goal_count4": 0,
"installs_by_day": [0, 0, 0, 0, 0, 0, 0],
"install_conv": 0.0,
"subtype1": "",
"clicks": 0,
"expandable": false,
"7_day_retention": 0},
...
]