Upsight logo Back to top

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