Upsight logo Back to top

Processed Data API

Discovery

Discovery Clicks


messages/discovery_clicks

URL

http://query.kontagent.net/processed/v1/social/messages/discovery_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.
discovery_type
  • games_my_recent
  • top_search
  • ts
  • nf
  • newsfeed
  • bookmarks
  • games_friends_apps
The type discovered.
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/discovery_clicks/series.json/?start_time=20110605_0000&api_key=&time_segment=week&end_time=20110705_0000&discovery_type=nf

Return:

[['2011-06-05', 1418],
['2011-06-12', 1717],
['2011-06-19', 1563],
['2011-06-26', 987],
['2011-07-03', 1215]]

Emails

Email Conversion


messages/email_conversion

URL

http://query.kontagent.net/processed/v1/social/messages/email_conversion/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/email_conversion/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0.0],
['2011-06-12', 0.0],
['2011-06-19', 0.0],
['2011-06-26', 0.0],
['2011-07-03', 0.0]]

Emails

Email Events


messages/email_events

URL

http://query.kontagent.net/processed/v1/social/messages/email_events/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/email_events/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Emails

Email Limit


messages/email_limit

URL

http://query.kontagent.net/processed/v1/social/messages/email_limit/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/email_limit/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Emails

Emails Received


messages/emails_received

URL

http://query.kontagent.net/processed/v1/social/messages/emails_received/<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 Kontagent 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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Kontagent, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/emails_received/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Emails

Emails Responses


messages/emails_responses

URL

http://query.kontagent.net/processed/v1/social/messages/emails_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/emails_responses/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Emails

Emails Sent


messages/emails_sent

URL

http://query.kontagent.net/processed/v1/social/messages/emails_sent/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/emails_sent/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Events

Events Count


URL

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

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.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3
gender
  • female
  • male
  • unknown
The user gender.
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/social/events/count/dict.json/?start_time=20121007_0000&api_key=&time_segment=day&end_time=20121107_0000

Return:

{
 "['EventName__1', 'EventSubtype1', 'EventSubtype2', 'EventSubtype3']":
    [["2012-10-07", 5], ["2012-10-08", 8], ["2012-10-09", 6], ["2012-10-10", 2],
     ["2012-10-11", 6], ["2012-10-12", 6], ["2012-10-13", 9], ["2012-10-14", 4],
     ["2012-10-15", 0], ["2012-10-16", 0], ["2012-10-17", 5], ["2012-10-18", 1],
     ["2012-10-19", 6], ["2012-10-20", 6], ["2012-10-21", 2], ["2012-10-22", 0],
     ["2012-10-23", 2], ["2012-10-24", 0], ["2012-10-25", 0], ["2012-10-26", 2],
     ["2012-10-27", 3], ["2012-10-28", 6], ["2012-10-29", 0], ["2012-10-30", 0],
     ["2012-10-31", 3], ["2012-11-01", 0], ["2012-11-02", 3], ["2012-11-03", 6],
     ["2012-11-04", 2], ["2012-11-05", 2], ["2012-11-06", 0], ["2012-11-07", 0]],

 "['EventName__2', 'EventSubtype1', 'EventSubtype2', 'EventSubtype3']":
    [["2012-10-07", 35], ["2012-10-08", 41],  ["2012-10-09", 31], ["2012-10-10", 27],
     ["2012-10-11", 30], ["2012-10-12", 40],  ["2012-10-13", 31], ["2012-10-14", 44],
     ["2012-10-15", 26], ["2012-10-16", 31],  ["2012-10-17", 56], ["2012-10-18", 65],
     ["2012-10-19", 94], ["2012-10-20", 143], ["2012-10-21", 77], ["2012-10-22", 63],
     ["2012-10-23", 52], ["2012-10-24", 65],  ["2012-10-25", 38], ["2012-10-26", 55],
     ["2012-10-27", 60], ["2012-10-28", 61],  ["2012-10-29", 58], ["2012-10-30", 62],
     ["2012-10-31", 54], ["2012-11-01", 48],  ["2012-11-02", 48], ["2012-11-03", 71],
     ["2012-11-04", 58],  ["2012-11-05", 61], ["2012-11-06", 47], ["2012-11-07", 58]],

 "['EventName__3', 'EventSubtype1', 'EventSubtype2', 'EventSubtype3']":
    [["2012-10-07", 1],  ["2012-10-08", 5],  ["2012-10-09", 12], ["2012-10-10", 6],
     ["2012-10-11", 4],  ["2012-10-12", 4],  ["2012-10-13", 4],  ["2012-10-14", 4],
     ["2012-10-15", 7],  ["2012-10-16", 7],  ["2012-10-17", 4],  ["2012-10-18", 7],
     ["2012-10-19", 8],  ["2012-10-20", 22], ["2012-10-21", 12], ["2012-10-22", 4],
     ["2012-10-23", 8],  ["2012-10-24", 10], ["2012-10-25", 6],  ["2012-10-26", 12],
     ["2012-10-27", 5],  ["2012-10-28", 12], ["2012-10-29", 10], ["2012-10-30", 9],
     ["2012-10-31", 10], ["2012-11-01", 7],  ["2012-11-02", 8],  ["2012-11-03", 7],
     ["2012-11-04", 6],  ["2012-11-05", 9],  ["2012-11-06", 5],  ["2012-11-07", 9]],

 "['EventName__4', 'EventSubtype1', 'EventSubtype2', 'EventSubtype3']":
    [["2012-10-07", 0], ["2012-10-08", 0],  ["2012-10-09", 1],  ["2012-10-10", 1],
     ["2012-10-11", 0], ["2012-10-12", 3],  ["2012-10-13", 1],  ["2012-10-14", 3],
     ["2012-10-15", 0], ["2012-10-16", 1],  ["2012-10-17", 1],  ["2012-10-18", 0],
     ["2012-10-19", 0], ["2012-10-20", 16], ["2012-10-21", 11], ["2012-10-22", 1],
     ["2012-10-23", 2], ["2012-10-24", 0],  ["2012-10-25", 1],  ["2012-10-26", 2],
     ["2012-10-27", 2], ["2012-10-28", 0],  ["2012-10-29", 5],  ["2012-10-30", 1],
     ["2012-10-31", 0], ["2012-11-01", 3],  ["2012-11-02", 2],  ["2012-11-03", 0],
     ["2012-11-04", 0],  ["2012-11-05", 1], ["2012-11-06", 1],  ["2012-11-07", 6]]}

Events

Events Count (Series)


events/count (series)

URL

http://query.kontagent.net/processed/v1/social/events/count/[series|total|avg].json/?api_key=<API KEY>&<other parameters>

Required Parameters

ParameterValuesDescription
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3
gender
  • female
  • male
  • unknown
The user gender.
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.

Events

Events Distribution


events/distribution

URL

http://query.kontagent.net/processed/v1/social/events/distribution/dict.json/?api_key=<API KEY>&<other parameters>

Required Parameters

ParameterValuesDescription
data_col
  • count
  • value
grouping
  • level
  • session
  • time_on_site
  • time_since_install
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_subtype1
event_subtype2
event_subtype3
event_name
gender
  • female
  • male
  • unknown
The user gender.
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.
normalize
xmin
xmax

Events

Events Names


URL

http://query.kontagent.net/processed/v1/social/events/names/list.json/?api_key=<API_KEY>&<other parameters>

Required Parameters

None

Optional Parameters

ParameterValuesDescription
event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3
names_only
  • y
  • n

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/events/names/list.json/?api_key=<API_KEY>

Return:

[{"name": "foo",         "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "click"}
 {"name": "foo",         "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "submit"}
 {"name": "bar",         "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "click"}
 {"name": "bar",         "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "submit"}
 {"name": "broken",      "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "click"}
 {"name": "tar",         "subtype1": "features",  "subtype2: "stats",       "subtype3": "score"}
 {"name": "tar",         "subtype1": "features",  "subtype2: "stats",       "subtype3": "leaderboard"}
 {"name": "other_foo",   "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "click"}
 {"name": “other_foo",   "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "submit"}
 {"name": “other_bar",   "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "click"}
 {"name": "other_bar",   "subtype1": "features",  "subtype2: "dictionary",  "subtype3": "submit"}
 {"name": "something",   "subtype1": "virality",  "subtype2: "post",        "subtype3": "stream"}
 {"name": "something2",  "subtype1": "virality",  "subtype2: "post",        "subtype3": "stream"}
 {"name": "place",       "subtype1": "features",  "subtype2: "stats",       "subtype3": "score"}
 {"name": "place",       "subtype1": "features",  "subtype2: "stats",       "subtype3": "stats"}
 {"name": "place",       "subtype1": "features",  "subtype2: "stats",       "subtype3": "leaderboard"}]

Events

Events Names_subtree


URL

http://query.kontagent.net/processed/v1/social/events/names_subtree/list.json/?api_key=<API_KEY>&<other parameters>

Required Parameters

None

Optional Parameters

ParameterValuesDescription
counts
event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/events/names_subtree/list.json/?api_key=<API_KEY>

Return:

[["features", 14],
 ["virality", 2]]

Events

Events Value


events/value

URL

http://query.kontagent.net/processed/v1/social/events/value/dict.json/?api_key=<API KEY>&<other parameters>

Required Parameters

ParameterValuesDescription
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_name
event_subtype1
event_subtype2
event_subtype3
gender
  • female
  • male
  • unknown
The user gender.
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.

Events

Events Value (series)


events/value (series)

URL

http://query.kontagent.net/processed/v1/social/events/value/dict.json/?api_key=<API KEY>&<other parameters>

Required Parameters

ParameterValuesDescription
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3
gender
  • female
  • male
  • unknown
The user gender.
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.

Installs

Installs All


users/installs_all (series)

URL

http://query.kontagent.net/processed/v1/social/users/installs_all/series.json/?api_key=<API KEY>&<other parameters>

Required Parameters

ParameterValuesDescription
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

event_filter
[["event_name", "event_subtype1", "event_subtype2", "event_subtype3"],
["event_name", "event_subtype1", "event_subtype2", "event_subtype3"]]
event_name
event_subtype1
event_subtype2
event_subtype3
gender
  • female
  • male
  • unknown
The user gender.
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.

Installs

Unique Installs


users/installs_unique

URL

http://query.kontagent.net/processed/v1/social/users/installs_unique/<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
age
  • 25
  • -100
  • 0-12
  • 65+
  • 25-29
  • 40-49
  • 18
  • 30
  • 13
  • 35
  • 50
  • 13-17
  • 0
  • 18-24
  • 40
  • unknown
  • 35-39
  • 50-64
  • 30-34
  • 65
The age group the user falls into.
countryPlease see the ISO-3166-1 alpha-2 list.The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • 11
  • 21-40
  • 81-125
  • 250+
  • 21
  • 0-10
  • unknown
  • 11-20
  • 41-60
  • 41
  • 0
  • -1
  • 126
  • 61-80
  • 250
  • 81
  • 126-250
The number of friends a user has. Defined by a friend range.
gender
  • F
  • m
  • f
  • M
  • u
  • female
  • unknown
  • U
  • male
The user gender.
group_by
  • location:country_abbreviation
  • demographic:gender
  • demographic:gender_abbreviation
  • location:continent
  • location:continent_abbreviation
  • location:country
  • demographic:age_range
The location or demographic group.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
parameters
  • ad
  • stream
  • canvas_bkmk_top
  • inr
  • ad_buy.spruce
  • partner
  • bookmarks
  • feedpub
  • nei
  • notification
  • ts
  • nf
  • ad_buy
  • email
  • discovery
  • invite
  • ntr
  • ad_buy.tbg
  • canvas_bkmk_more
  • games_friends_apps
  • games_my_recent
  • fdp
  • dashboard_activityi
  • dashboard
  • ad_buy.tlm
  • feedstory
source_subtype1The st1 parameter name as defined by you in the UCC API call.
source_subtype2The st2 parameter name as defined by you in the UCC API call.
source_subtype3The st3 parameter name as defined by you in the UCC API call.
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.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/installs_unique/series.json/?app_handle=sample&start_time=20120101_0000&end_time=20120201_0000&time_segment=day

Return:

[["2012-01-01", 585],
["2012-01-02", 610],
["2012-01-03", 672],
["2012-01-04", 741],
...,
["2012-01-31", 244],
["2012-02-01", 222]]

Installs

Removes


users/removes

URL

http://query.kontagent.net/processed/v1/social/users/removes/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/users/removes/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 43848],
['2011-06-12', 46236],
['2011-06-19', 44016],
['2011-06-26', 41401],
['2011-07-03', 48816]]

Invites

Invite Conversation


messages/invite_conversion

URL

http://query.kontagent.net/processed/v1/social/messages/invite_conversion/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/invite_conversion/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0.12633262260127931],
['2011-06-12', 0.071874999999999994],
['2011-06-19', 0.074100211714890618],
['2011-06-26', 0.078141499472016901],
['2011-07-03', 0.092018301982714795]]

Invites

Invite Events


messages/invite_events

URL

http://query.kontagent.net/processed/v1/social/messages/invite_events/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/invite_events/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 1728],
['2011-06-12', 547],
['2011-06-19', 475],
['2011-06-26', 340],
['2011-07-03', 411]]

Invites

Invite Limit


messages/invite_limit

URL

http://query.kontagent.net/processed/v1/social/messages/invite_limit/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics , they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/invite_limit/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 50],
['2011-06-12', 50],
['2011-06-19', 50],
['2011-06-26', 50],
['2011-07-03', 50]]

Invites

Invites Received


messages/invites_received

URL

http://query.kontagent.net/processed/v1/social/messages/invites_received/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/invites_received/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 1470],
['2011-06-12', 794],
['2011-06-19', 710],
['2011-06-26', 578],
['2011-07-03', 769]]

Invites

Invite Responses


messages/invite_responses

URL

http://query.kontagent.net/processed/v1/social/messages/invite_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/invite_responses/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 474],
['2011-06-12', 230],
['2011-06-19', 210],
['2011-06-26', 148],
['2011-07-03', 181]]

Invites

Invites Sent


messages/invites_sent

URL

http://query.kontagent.net/processed/v1/social/messages/invites_sent/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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 INS API call.
source_subtype2 The st2 parameter name as defined by you in the INS API call.
source_subtype3 The st3 parameter name as defined by you in the INS 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 INS API call.

Code Example

Query URL:

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

Return:

[['2011-06-05', 3752],
['2011-06-12', 3200],
['2011-06-19', 2834],
['2011-06-26', 1894],
['2011-07-03', 1967]]

Messages

Messages Sent


messages/messages_sent

URL

http://query.kontagent.net/processed/v1/social/messages/messages_sent/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/messages_sent/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Messages

Messages Clicked


messages/messages_clicks

URL

http://query.kontagent.net/processed/v1/social/messages/messages_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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/messages_clicks/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Messages

Messages Responded


messages/messages_responses

URL

http://query.kontagent.net/processed/v1/social/messages/messages_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/messages_clicks/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Monetization

Revenue


monetization/revenue

URL

http://query.kontagent.net/processed/v1/social/monetization/revenue/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/social/monetization/revenue/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 96539.199999999997],
['2011-06-12', 145776.53],
['2011-06-19', 134708.67999999999],
['2011-06-26', 112016.97],
['2011-07-03', 74270.0]]

Monetization

Transactions


monetization/transactions

URL

http://query.kontagent.net/processed/v1/social/monetization/transactions/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/social/monetization/transactions/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 1928],
['2011-06-12', 2726],
['2011-06-19', 2222],
['2011-06-26', 1698],
['2011-07-03', 754]]

Monetization

Average Transaction


monetization/average_transaction

URL

http://query.kontagent.net/processed/v1/social/monetization/average_transaction/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/monetization/average_transaction/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 50.072199170124478],
['2011-06-12', 53.476349963316217],
['2011-06-19', 60.624968496849689],
['2011-06-26', 65.969946996466433],
['2011-07-03', 98.50132625994695]]

Monetization

ARPPU


monetization/arppu

URL

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

Data Output Types

A

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
  • 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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/monetization/arppu/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 145.39036144578313],
['2011-06-12', 157.42605831533479],
['2011-06-19', 168.80786967418547],
['2011-06-26', 164.48894273127755],
['2011-07-03', 142.82692307692309]]

Monetization

Spending Users


monetization/spending_users

URL

http://query.kontagent.net/processed/v1/social/monetization/spending_users/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/monetization/spending_users/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=day&end_time=20110705_0000

Return:

[['2011-06-05', 0.0051155115511551151],
['2011-06-06', 0.0043227665706051877],
['2011-06-07', 0.005483576151819795],
['2011-06-08', 0.0044262662483191394],
['2011-06-09', 0.0054814647377938513],
['2011-06-10', 0.0057260650480989465],
['2011-06-11', 0.0063679781669319993],
['2011-06-12', 0.0069722755970354107],
['2011-06-13', 0.0068695298188479548],
['2011-06-14', 0.0066663023878476583],
...

Notifications

Notification Conversion


messages/notification_conversion

URL

http://query.kontagent.net/processed/v1/social/query/messages/notification_conversion/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notification_conversion/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Notifications

Notification Events


messages/notification_events

URL

http://query.kontagent.net/processed/v1/social/messages/notification_events/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notification_events/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Notifications

Notification Limit


messages/notification_limit

URL

http://query.kontagent.net/processed/v1/social/messages/notification_limit/<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 Kontagent 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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Kontagent, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notification_limit/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Notifications

Notifications Sent


messages/notifications_sent

URL

http://query.kontagent.net/processed/v1/social/messages/notifications_sent/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notifications_sent/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Notifications

Notifications Received


messages/notifications_received

URL

http://query.kontagent.net/processed/v1/social/messages/notifications_received/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notifications_received/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],

['2011-07-03', 0]]

Notifications

Notifications Responses


messages/notifications_responses

URL

http://query.kontagent.net/processed/v1/social/messages/notifications_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/notifications_responses/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Virality

Virality


users/virality

URL

http://query.kontagent.net/processed/v1/social/users/virality/<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.
duration1, 3, 7, 28, allThe 1-day, 3-day, 7-day, or 28-day virality associated with your app. By passing the value "all", this returns the total virality for the entire life of your app.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/users/virality/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000&duration=7

Return:

[['2011-06-05', 0.014611934212314803],
['2011-06-12', 0.015854235683861809],
['2011-06-19', 0.014307051332442419],
['2011-06-26', 0.013651877133105802],
['2011-07-03', 0.011584824923028753]]

Returning Users

Returning


users/returning

URL

http://query.kontagent.net/processed/v1/social/users/virality/<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.
duration1, 3, 7, 28, allThe 1-day, 3-day, 7-day, or 28-day virality associated with your app. By passing the value "all", this returns the total virality for the entire life of your app.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/users/virality/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000&duration=7

Return:

[['2011-06-05', 0.014611934212314803],
['2011-06-12', 0.015854235683861809],
['2011-06-19', 0.014307051332442419],
['2011-06-26', 0.013651877133105802],
['2011-07-03', 0.011584824923028753]]

Stream

Stream Posts


messages/stream_posts

URL

http://query.kontagent.net/processed/v1/social/messages/stream_posts/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/stream_posts/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 6347],
['2011-06-12', 5590],
['2011-06-19', 5518],
['2011-06-26', 4582],
['2011-07-03', 6239]]

Stream

Stream Clicks


messages/stream_clicks

URL

http://query.kontagent.net/processed/v1/social/messages/stream_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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/stream_clicks/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 2146],
['2011-06-12', 2488],
['2011-06-19', 2535],
['2011-06-26', 1916],
['2011-07-03', 2742]]

Stream

Stream Responses


messages/stream_responses

URL

http://query.kontagent.net/processed/v1/social/messages/stream_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/stream_responses/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 2146],
['2011-06-12', 2488],
['2011-06-19', 2535],
['2011-06-26', 1916],
['2011-07-03', 2742]]

Stream

Stream Post/Click Ratio


messages/stream_post_click_ratio

URL

http://query.kontagent.net/processed/v1/social/messages/stream_post_click_ratio/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/stream_post_click_ratio/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0.33811249409169686],
['2011-06-12', 0.44508050089445439],
['2011-06-19', 0.45940558173251178],
['2011-06-26', 0.41815800960279353],
['2011-07-03', 0.43949350857509217]]

Stream

Feedpub Posts


messages/feedpub_posts

URL

http://query.kontagent.net/processed/v1/social/messages/feedpub_posts/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/feedpub_posts/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Stream

Feedpub Clicks


messages/feedpub_posts

URL

http://query.kontagent.net/processed/v1/social/messages/feedpub_posts/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/feedpub_posts/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Stream

Feedpub Responses


messages/feedpub_responses

URL

http://query.kontagent.net/processed/v1/social/messages/feedpub_responses/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/feedpub_responses/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

Stream

Feedpub Post/Click Ratio


messages/feedpub_post_click_ratio

URL

http://query.kontagent.net/processed/v1/social/messages/feedpub_post_click_ratio/<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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/messages/feedpub_post_click_ratio/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 0],
['2011-06-12', 0],
['2011-06-19', 0],
['2011-06-26', 0],
['2011-07-03', 0]]

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]]

Traffic

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},
...
]

Traffic

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
    ]
]

Traffic

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},
...
]

Time

Goal Counts


events/goal_counts

URL

http://query.kontagent.net/processed/v1/social/events/goal_counts/[series|total|avg].json/?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.
goal_count_index1 .. 4These values correspond to the gcn parameter in the GCI API call.
start_timeYYYYmmdd_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/social/events/goal_counts/series.json/?api_key=<API_KEY>&goal_count_index=1&start_time=20121101_0000&end_time=20121108_0000&time_segment=day

Return:

[["2012-11-06", 140], 
 ["2012-11-07", 427], 
 ["2012-11-08", 417]]

Time

Pageviews


events/pageviews

URL

http://query.kontagent.net/processed/v1/social/events/pageviews/[series|total|avg].json/
?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_HHMMThe start time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
end_timeYYYYmmdd_HHMMThe end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
time_segment
  • hour
  • day
  • week
  • month
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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/social/events/pageviews/series.json/?api_key=<API_KEY>&start_time=20121101_0000&end_time=20121108_0000&time_segment=day

Return:

[["2012-11-01", 101302],
 ["2012-11-02", 88135],
 ["2012-11-03", 80551],
 ["2012-11-04", 91245],
 ["2012-11-05", 93155],
 ["2012-11-06", 87213],
 ["2012-11-07", 94574],
 ["2012-11-08", 103863]]

User Distribution

Gender Distribution


users/gender_distribution

URL

http://query.kontagent.net/processed/v1/social/users/gender_distribution/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/gender_distribution/list.json/?api_key=<API KEY>

Return:

[['App', 1],
['Female', 23584],
['Male', 459696],
['Unknown', 45938]]

User Distribution

Age Distribution


users/age_distribution

URL

http://query.kontagent.net/processed/v1/social/users/age_distribution/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/age_distribution/list.json/?api_key=<API KEY>

Return:

[['0 - 12', 35609],
['13 - 17', 202983],
['18 - 24', 153281],
['25 - 29', 38235],
['30 - 34', 25781],
['35 - 39', 11536],
['40 - 49', 9719],
['50 - 64', 2938],
['65+', 3156],
['None', 1],
['Unknown', 45980]]

User Distribution

Friends Distribution


users/friends_distribution

URL

http://query.kontagent.net/processed/v1/social/users/friends_distribution/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/friends_distribution/list.json/?api_key=<API KEY>

Return:

[['0 - 10', 17577],
['11 - 20', 13162],
['126 - 250', 119992],
['21 - 40', 28785],
['250+', 190123],
['41 - 60', 28401],
['61 - 80', 26792],
['81 - 125', 55068],
['None', 1],
['Unknown', 49318]]

User Distribution

Country Distribution


users/country_distribution

URL

http://query.kontagent.net/processed/v1/social/users/country_distribution/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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.
country_display_value
  • abbreviation
  • iso-3166
  • iso3166
  • name
How you would like the country name be displayed in the output data.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/country_distribution/list.json/?api_key=<API KEY>

Return:

[['Afghanistan', 13],
['Albania', 1487],
['Algeria', 966],
['Andorra', 9],
['Angola', 51],
['Anguilla', 3],
['Antigua and Barbuda', 24],
['App', 1],
['Argentina', 9051],
['Armenia', 40],
...

User Distribution

Continent Distribution


users/continent_distribution

URL

http://query.kontagent.net/processed/v1/social/users/continent_distribution/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/continent_distribution/list.json/?api_key=<API KEY>

Return:

[['Africa', 7349],
['App', 1],
['Asia', 121622],
['Europe', 281043],
['North America', 39500],
['Oceania', 6818],
['South America', 45058],
['Unknown', 27828]]

User Retention

Retention


users/retention

URL

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

Data Output Types

ParameterValuesDescription
data_type
  • series
  • list

The output data type.

Tip You may use series.json works for both mobile and social. However, avoid using list.json for mobile, as you will get an error.

data_formatjsonThe 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.
time_segment
  • week
  • 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. Similarly, a time segment by hour returns the data on an hourly basis between the start and end times specified.

Optional Parameters

ParameterValuesDescription
end_timeYYYYmmdd_HHMMRequired if data_type islist. The end time element (day, week, month) in the time range being queried in the YYYYmmdd_HHMM format.
trailing_zeros
  • true
  • false

This parameter can only be used if data_type = list is selected. Default is false.

cohorts
  • 1
  • 2
  • 3
  • 4 (Default)
  • 5
  • 6
This parameter can only be used if data_type = list is selected. Default is 4.

When used with data_type=list, cohorts gives you the ability to look at multiple days/weeks/months worth of retention data. If cohort=1 (default) you will see retention metrics just for that day/week/month. If cohort=4, you will see retention metrics for 4 consecutive days/weeks/months (starting with the start_time day). The range of values for cohort is 1-6.

duration
  • 1 - 12
This parameter can only be used if data type = list is selected.

when used with data_type=list, duration allows you to choose how many days/weeks/months worth of retention data you want to see for each cohort. If duration=1, you will only get 1-day/week/month retention. If duration=6, you will get day/week/month 1-6 retention. Range of values of duration is 1-7.

offset
  • series
This parameter allows you to identify day/week/month 'n' retention (e.g., offset=1 is day-1 retention, offset=7 is day 7 retention). The allowed values are 1-7.

Code Example

Social Query URL:

http://query.kontagent.net/processed/v1/social/users/retention/list.json/?api_key=<API KEY>&start_time=20120101_0000&time_segment=day

Return:

[
[
[0, 1.0],
[1, 0.17606837606837608],
[2, 0.090598290598290596],
[3, 0.076923076923076927],
[4, 0.066666666666666666],
[5, 0.058119658119658121],
[6, 0.056410256410256411],
[7, 0.052991452991452991],
[8, 0.05128205128205128]
],
[
...
],
...
]

User Sessions

Count


session/count

URL

http://query.kontagent.net/processed/v1/social/session/count/<DATA TYPE>.<DATA FORMAT>/?api_key=<API KEY>&<PARAMETER>=<VALUE>

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
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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.
durationThis parameter can only be used if data_type = list is selected.

Code Example

Query URL:

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

Return:

[['2011-06-05', 283695],
['2011-06-12', 310616],
['2011-06-19', 309293],
['2011-06-26', 277249],
['2011-07-03', 287560]]

User Sessions

Average Session Length


session/avg_length

URL

http://query.kontagent.net/processed/v1/social/session/avg_length/<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
countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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_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/session/avg_length/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 947.52098556548401],
['2011-06-12', 977.23060949854482],
['2011-06-19', 965.47103232210236],
['2011-06-26', 945.55859894895923],
['2011-07-03', 944.47725344275977]]

Unique Visitors

Uniques


users/uniques

URL

http://query.kontagent.net/processed/v1/social/users/uniques/<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
  • 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
countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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/social/users/uniques/series.json/?start_time=20110605_0000&api_key=<API KEY>&time_segment=week&end_time=20110705_0000

Return:

[['2011-06-05', 43848],
['2011-06-12', 46236],
['2011-06-19', 44016],
['2011-06-26', 41401],
['2011-07-03', 48816]]

Unique Visitors

Uniques Rolling


users/uniques_rolling

URL

http://query.kontagent.net/processed/v1/social/users/uniques_rolling/<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.

Optional Parameters

ParameterValuesDescription
age
  • unknown
  • 0-12
  • 13-17
  • 18-24
  • 25-29
  • 30-34
  • 35-39
  • 40-49
  • 50-64
  • 65+

The age group the user falls into.

countryPlease see the ISO-3166-1 alpha-2 list.

The country code of the country in which the user is located. The country code must be in upper case format and conform to the ISO-3166-1 alpha-2 standard. If not sent, it will be based on the user's IP.

Note! The Facebook locales ar_AR and es_LA do not follow the ISO standard. Facebook uses them to denote umbrella locales for Arabic and Spanish speaking regions. If you send the last two characters of these locales to Upsight Analytics, they will map to Argentina and Laos. As a best practice, if you see these locales, do not pass the country code. For additional information on Facebook locales, click here.

friends
  • unknown
  • 0-10
  • 11-20
  • 21-40
  • 41-60
  • 61-80
  • 81-125
  • 126-250
  • 250+
The number of friends a user has. Defined by a friend range.
gender
  • female
  • male
  • unknown
The user gender.
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.
days_rolling
  • 7
  • 30
The number of days rolling.

Code Example

Query URL:

http://query.kontagent.net/processed/v1/social/users/uniques_rolling/series.json/?start_time=20110605_0000&api_key=<API KEY>&end_time=20110705_0000&days_rolling=30

Return:

[['2011-06-05', 96517],
['2011-06-06', 98633],
['2011-06-07', 100197],
['2011-06-08', 101216],
['2011-06-09', 102093],
['2011-06-10', 103254],
['2011-06-11', 104958],
['2011-06-12', 106619],
['2011-06-13', 108512],
['2011-06-14', 109310],
...