Viral Optimizer A/B TestingHere is the documentation for RESTful API for the viral optimizer A/B testing.
Common URL FormatThe basic structure of the URL used to send data to the analytics data capture back‐end server is:api.geo.kontagent.net/api/<version number>/<apikey>/<message type>/?<key>=<data>
e.g.api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/ins/?s=123&r=456%2C789&u=0123456789abcdef
The question mark character is followed by one or more parameters. These parameters are only unique to a message and the same variable name can take on different meanings when used in conjunction with different message types.
Example code (PHP):
|
| Name | Parameter | Type | Description | Optional |
| Sender UID |
s | int | The UID of the user sending the invite. For app-to-user notifications, set this value to '0' (zero). |
No |
| Recipient UIDs |
r | array | The list of recipient UIDs separated by commas (and URL-encoded) |
No |
| Unique tracking tag |
u | char(16) |
A unique tracking tag that is used to match Invite Sent messages to Invite Click Responses. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Invite subtype 1 - Must match subtype 1 of the corresponding Invite Click Response Message |
Yes |
| Subtype 2 |
st2 | char(32) | Invite subtype 2 - Must match subtype 2 of the corresponding Invite Click Response Message |
Yes |
| Subtype 3 | st3 | char(32) | Invite subtype 3 - Must match subtype 3 of the corresponding Invite Click Response Message | Yes |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/ins/?s=123&r=456%2C789&u=9a3d9332b31632a0
Invite Click Response
Message type: inrStatus: Active
Description: This message is sent when an invite recipient responds to an invite and visits the application.
Variables:
| Name | Parameter | Type | Description | Optional |
| Recipient UID |
r | int | The UID of the recipient responding to the invite. This value may not be available if the user has not yet added the application |
Yes |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) |
No |
| Unique tracking tag |
u | char(16) |
The unique tracking tag that was contained in the invite that is being responded to. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Invite subtype 1 - Must match subtype 1 of the corresponding Invite Sent message |
Yes |
| Subtype 2 |
st2 | char(32) | Invite subtype 2 - Must match subtype 2 of the corresponding Invite Sent message |
Yes |
| Subtype 3 | st3 | char(32) | Invite subtype 3 - Must match subtype 3 of the corresponding Invite Send message | Yes |
Example:
api.geo.kontagent.net/api/v1/b7d1c5a521984d308c3ad979a5b6e8f7/inr/?r=456&i=1&u=0123456789abcdef
Notification Sent
Message type: ntsStatus: Active
Description: This message is sent when a notification event occurs. Multiple recipients can be specified in this message.
Variables:
| Name | Parameter | Type | Description | Optional |
| Sender UID |
s | int | The UID of the user sending the notification |
No |
| Recipient UIDs |
r | array | The list of recipient UIDs separated by commas (and URL-encoded) | No |
| Unique tracking tag |
u | char(16) |
A unique tracking tag that is used to match Notification Sent messages to Notification Click Responses. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Notification subtype 1 - Must match subtype 1 of the corresponding Notification Click Response message |
Yes |
| Subtype 2 |
st2 | char(32) | Notification subtype 2 - Must match subtype 2 of the corresponding Notification Click Response message |
Yes |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/nts/?s=123&r=456%2C789&u=9a3d9332b31632a0
Notification Click Response
Message type: ntrStatus: Active
Description: This message is sent when a notification recipient responds to a notification and visits the application.
Variables:
| Name | Parameter | Type | Description | Optional |
| Recipient UID |
r | int(6) | The UID of the recipient responding to the notification. This value may not be available if the user has not yet added the application |
Yes |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) |
No |
| Unique tracking tag |
u | char(16) |
The unique tracking tag that was contained in the notification that is being responded to. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Notification subtype 1 - Must match subtype 1 of the corresponding Notification Sent message |
Yes |
| Subtype 2 |
st2 | char(32) | Notification subtype 2 - Must match subtype 2 of the corresponding Notification Sent message |
Yes |
Example:
api.geo.kontagent.net/api/v1/b7d1c5a521984d308c3ad979a5b6e8f7/ntr/?r=456&i=1&u=0123456789abcdef
Notification E-mail Sent
Message type: nesDescription: This message is sent when an e-mail notification event occurs. Multiple recipients can be specified in this message.
Status: Active
Variables:
| Name | Parameter | Type | Description | Optional |
| Sender UID |
s | int | The UID of the user sending the e-mail |
No |
| Recipient UIDs |
r | array | The list of recipient UIDs separated by commas (and URL-encoded) | No |
| Unique tracking tag |
u | char(16) |
A unique tracking tag that is used to match Notification Email Sent messages to Notification Email Click Responses. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Notification E-mail subtype 1 - Must match subtype 1 of the corresponding Notification E-mail Sent message |
Yes |
| Subtype 2 |
st2 | char(32) | Notification E-mail subtype 2 - Must match subtype 2 of the corresponding Notification E-mail Sent message |
Yes |
| Subtype 3 | st3 | char(32) | Notification E-mail subtype 3 - Must match subtype 3 of the corresponding Notification E-mail Sent message | Yes |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/nes/?s=123&r=456%2C789&u=9a3d9332b31632a0
Notification Email Click Response
Message type: neiStatus: Active
Description: This message is sent when an e-mail notification recipient responds to an e-mail notification and visits the application.
Variables:
| Name | Parameter | Type | Description | Optional |
| Recipient UID |
r | int | The UID of the recipient responding to the e-mail. This value may not be available if the user has not yet added the application |
Yes |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) |
No |
| Unique tracking tag |
u | char(16) |
The unique tracking tag that was contained in the e-mail that is being responded to. See the Unique Tracking Tags section for details. |
No |
| Subtype 1 |
st1 | char(32) | Notification E-mail subtype 1 - Must match subtype 1 of the corresponding Notification E-mail Sent message |
Yes |
| Subtype 2 |
st2 | char(32) | Notification E-mail subtype 2 - Must match subtype 2 of the corresponding Notification E-mail Sent message |
Yes |
| Subtype 3 | st3 | char(32) | Notification E-mail subtype 3 - Must match subtype 3 of the corresponding Notification E-mail Sent message | Yes |
Example:
api.geo.kontagent.net/api/v1/b7d1c5a521984d308c3ad979a5b6e8f7/nei/?r=456&i=1&u=9a3d9332b31632a0
Message Sent
Message type: mesStatus: Active
Description: This message is sent when a user or the application sends a message directed at one or more specific users. The FB API calls that should use this message to submit information are:
| Channel type | FB interface |
| dashboard | dashboard.addNews |
| dashboard | dashboard.multiAddNews |
Variables:
| Name | Parameter | Type | Description | Optional |
| Sender |
s | int | The UID of the user who the message is from (0 = from app) |
No |
| Recipients | r | array | The UID(s) of the recipient(s) | No |
| Type | tu | char(16) | Channel type (Only 'dashboard' is supported at this time) |
No |
| Subtype 1 |
st1 | char(32) | Message subtype 1 - Must match subtype 1 of the corresponding Message Response API call | Yes |
| Subtype 2 |
st2 | char(32) | Message subtype 2 - Must match subtype 2 of the corresponding Message Response API call | Yes |
| Subtype 3 | st3 | char(32) | Message subtype 3 - Must match subtype 3 of the corresponding Message Response API call | Yes |
| Tracking tag |
u | char(16) | A unique tracking tag that is used to match messages to message responses. See the Unique Tracking Tags section for details. |
No |
Examples:
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mes/?s=12345678&r=23456789&tu=dashboard&u=0123456789abcdef
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mes/?s=0&r=23456789&tu=dashboard&u=0123456789abcdef
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mes/?s=12345678&r=23456789%2C34567890&tu=dashboard&u=0123456789abcdef
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mes/?s=12345678&r=23456789&tu=dashboard&u=0123456789abcdef&st1=game&st2=challenge
Message Response
Message type: mer
Status: Active
Description: This message is sent when a user responds to a message sent specifically to them.
Variables:
Status: Active
Description: This message is sent when a user responds to a message sent specifically to them.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
r | int | The UID of the user who is responding to the message (i.e. clicked on a link in the message) |
Yes |
| Type | tu | char(16) | Channel type (Only 'dashboard' is supported at this time) of the message being responded to |
No |
| Subtype 1 |
st1 | char(32) | Subtype 1 of the message being responded to - Must match subtype 1 of the corresponding Message API call | Yes |
| Subtype 2 |
st2 | char(32) | Subtype 2 of the post being responded to - Must match subtype 2 of the corresponding Message API call | Yes |
| Subtype 3 | st3 | char(32) | Subtype 3 of the post being responded to - Must match subtype 3 of the corresponding Message API call | Yes |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) | No |
| Tracking tag |
u | char(16) | Tracking tag associated with the original message. See the Unique Tracking Tags section for details. |
Varies |
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mer/?r=23456789&tu=dashboard&u=0123456789abcdef&i=0
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mer/?r=23456789&tu=dashboard&u=0123456789abcdef&i=0&st1=game&st2=challenge
Post
Message type: pstStatus: Active
Description: This message is sent when a user posts using one of the channels FB has available for posting information to a variety of places on the Facebook website. The FB API calls and FBML-based posting methods that should use this message to submit information are:
| Channel type | FBML or API | FB interface |
| feedpub | API | Feed.publishUserAction |
| stream | API | Stream.publish |
| feedstory | FBML | feed_story |
| multifeedstory | FBML | multi_feed_story |
| dashboard_activity | API | dashboard.publishActivity |
| dashboard_globalnews | API | dashboard.addGlobalNews |
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user who made the post |
No |
| Type | tu | char(16) | Channel type. Must be one of the entries from the 'Channel type' column in the table above. Messages with other values will be ignored. |
No |
| Subtype 1 |
st1 | char(32) | Subtype 1 of the post - Must match subtype 1 of the corresponding Post Response message | Yes |
| Subtype 2 |
st2 | char(32) | Subtype 2 of the post - Must match subtype 2 of the corresponding Post Response message | Yes |
| Subtype 3 | st3 | char(32) | Subtype 3 of the post - Must match subtype 3 of the corresponding Post Response message | Yes |
| Tracking tag |
u | char(16) | A unique tracking tag that is used to match posts to post responses. See the Unique Tracking Tags section for details. |
No |
Examples:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/pst/?s=456&tu=feedstory&u=0123456789abcdef
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/pst/?s=456&tu=feedstory&st1=game&st2=start&u=0123456789abcdef
Post Response
Message type: psrStatus: Active
Description: This message is sent when a user clicks on a link in a post made using one of the channels listed in the section for the 'Post' API call.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
r | int | The UID of the user who is responding to the post (i.e. clicked on a link in the post) |
Yes |
| Type | tu | char(16) | Channel type (one of the entries from the 'Channel type' column in the table in the section for the 'Post' API call) of the post being responded to |
No |
| Subtype 1 |
st1 | char(32) | Subtype 1 of the post being responded to - Must match subtype 1 of the corresponding Post message | Yes |
| Subtype 2 |
st2 | char(32) | Subtype 2 of the post being responded to - Must match subtype 2 of the corresponding Post message | Yes |
| Subtype 3 | st3 | char(32) | Subtype 3 of the post being responded to - Must match subtype 3 of the corresponding Post message | Yes |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) | No |
| Tracking tag |
u | char(16) | Tracking tag associated with the original post. See the Unique Tracking Tags section for details. |
Varies |
Examples:
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/psr/?tu=feedpub&u=0123456789abcdef&i=0
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/psr/?tu=feedpub&st1=game&st2=start&u=0123456789abcdef&i=0
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/psr/?s=23456789&tu=stream&u=0123456789abcdef&i=1
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/psr/?r=23456789&tu=feedpub&u=0123456789abcdef&i=1
Message type: evt
Status: In Private Beta (Contact us for more details)
Description: This message is sent when a user triggers an application-defined event.
Variables:
Status: In Private Beta (Contact us for more details)
Description: This message is sent when a user triggers an application-defined event.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID | s | int | The UID of the user who is responding to the post (i.e. clicked on a link in the post) | No |
| Event name | n | char(32) | A name describing the event (should only contain the characters [a-zA-Z0-9_] for now) | No |
| Subtype 1 | st1 | char(32) | A label to categorize the event (see below) | Yes |
| Subtype 2 | st2 | char(32) | A label to categorize the event (see below) | Yes |
| Subtype 3 | st3 | char(32) | A label to categorize the event (see below) | Yes |
| Value | v | int | A value to associate with the event (defaults to 1) | Yes |
| Level | l | int | A level to associate with the event (defaults to 1) | Yes |
Using Subtypes
Subtypes can be used to group events together. A hierarchical approach is used, with subtype 1 at the top level of the hierarchy and subtype3 at the bottom. The UI will allow you to select groups of events with the same subtype for comparison. For example, you will be able to select subtype1 = "purchase" and then subtype2 = "accessory" in the UI, and you would then be able to compare the following events
It is important that the same subtype values are consistently used with a given event name. All of the following events will be classified as different events because none has the same subtype valuehttp://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=plow&st1=purchase&st2=accessoryhttp://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=shovel&st1=purchase&st2=accessoryhttp://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=rake&st1=purchase&st2=accessory
Using Levelhttp://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=event1http://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=event1&st1=label1http://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=event1&st1=label2http://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=event1&st1=label1&st2=label2http://api.geo.kontagent.net/api/v1/YOUR_API_KEY/evt/?s=123&n=event1&st1=label1
A level value can be associated with an event to indicate what game level the user associated with the event is at in the game. It will be possible in the UI to view aggregate event counts by level. The level must be a positive integer.
Application Added
Message type: apaStatus: Active
Description: This message is sent when a user adds an application. The presence of a tracking tag or a short tracking tag is used to determine the source of the add. The absence of a tracking tag means the user added the application without coming through one of our trackable channels.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user adding the application |
No |
| Tracking tag |
u | char(16) | The unique tracking tag from an invite, notification, e-mail, or post if the user added the application as a result of responding to an invite, notification, or e-mail or clicked on the link in a post. Important: If this tag is not included for installs as a result of invite, notification, e-mail or post responses, it will not be counted towards virality which means you will get a lower virality value than the actual virality value. |
Required if install is a viral install through an invite, notification, email or post. Optional otherwise. |
| Short tracking tag |
su | char(8) | The short unique tracking tag added on the landing page if the user added the application as a result of responding to any form of undirected communication (e.g., ads, links on partner sites) Important: If this tag is not included for installs resulting from ad or partner clicks (reported using the ucc message), traffic source information will not be properly attributed. |
Required if install is an install through a ucc event. Optional otherwise. |
| profile tracking tag |
ru |
char(16) | The profile tracking tag is added if the user added the application as a result of clicking on profilebox or profileinfo links. Unlike u and su, it is not a uuid. ru is simply the uid of the profile owner. |
Currently unused. |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/apa/?s=456&su=84a942ad
Application Removed
Message type: aprStatus: Active
Description: This message is sent when a user removes an application.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user removing the application |
No |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/apr/?s=456
Undirected Communication Click
Message type: uccStatus: Active
Description: This message is sent when a click from an undirected communication source, e.g., an ad, partner link, feed post, or profile, is detected. Note that at this point the UID may not be sent since the user may not have added the application, yet.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user who responded to a form of undirected communication |
Yes |
| Type | tu | char(16) | Undirected communication type, e.g. "ad" |
No |
| Subtype 1 |
st1 | char(32) | Yes | |
| Subtype 2 |
st2 | char(32) | Yes | |
| Subtype 3 | st3 | char(32) | Yes | |
| Has app installed |
i | byte | Indicates whether the recipient has already installed the app (1 or 0) | No |
| Short tracking tag |
su | char(8) | Short tracking tag added to track if user installs the application or not (can be omitted if the user already has the application added). This is an 8-, 16-, or 32-byte hex random string, if present. Tracking tags for ucc messages should be unique. |
Yes |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/ucc/?tu=ad&st1=abc&st2=123&i=0&su=84a94add&s=456734
Page Request (also used to determine the user location by GeoIP)
Message type: pgrStatus: Active
Description: This message is sent when a page request is made by a user. Should be implemented as an embedded "pixel" on the browser side.
Important: It should be noted that the browser IP is used to determine the location of the user. As such, it is critical that the pixel be loaded by the browser and not by the application server.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user who requested the page |
No |
| timestamp | ts | char | Time stamp based on GMT. The purpose of having this parameter is to prevent user's browser from caching the img tag since the src attribute will be unique. |
No |
| IP address | ip | char(15) | The IP address of the user requesting the page can be specified using this parameter. If this message is posted to the server directly from the end user's browser (i.e. if the request is made by embedding an image into the application's pages), it is not necessary to set this parameter. | Yes |
| Page address | u | char(256) | The page address to be recorded can be set manually using this parameter. If this message is posted to the server directly from the end user's browser by embedding an image into the application's pages, it is not necessary to set this parameter since the address of the page can be derived from the referer information in the HTTP header. | Yes |
Example:
<img src="http://api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/pgr/?s=456&ts=2009-4-22T04:08:35" width="0" height="0"/>
User Information
Message type: cpuStatus: Active
Description: This message provides information about a specific user.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | int | The UID of the user |
No |
| Birth year |
b | int | The year of the user's birth |
Yes |
| Gender | g | char(1) | The gender of the user (male ("m"), female ("f"), unknown ("u")) |
Yes |
| City | ly | string | The city in which the user is located |
Yes (currently unused) |
| Country | lc | string | The country in which the user is located |
Yes |
| State | ls | string | The state in which the user is located |
Yes |
| Postal code/zip |
lp | string | The postal (or zip) code for the user's location |
Yes |
| Friend count |
f | int | The number of friends the user has |
Yes |
Implementation Note (when and how frequently should we send this data?): One common issue with the 'cpu' message is when and how often to send this data. We recommend that you place the code that retrieves the data from Facebook and sends it to Kontagent in a very common place in your application (i.e. the first page) so every user hits it. Instead of sending it every time the user hits the page though, set a cookie in the user's browser(with an expiration of 2 weeks) that indicates the user data was retrieved and sent. You can also set it to a longer time period if you want -- you get more recent data, but there's a bit more a burden on your servers. This way, the data is only updated once every 2 weeks (or whatever you set the expiration to) and it won't degrade the performance of your application. For an example of this implementation, you can take a look at our PHP or Ruby libraries.
Example:
Goal Counts
Message type: gci
Status: Active - Premium Only
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/cpu/?s=142345&f=142&g=m&b=1980&lc=US
Goal Counts
Message type: gciStatus: Active - Premium Only
Description: This message provides information for incrementing goal counts for individual users.
Variables:
Examples:
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | array | The UID(s) of the user(s) for which goals count increments are being submitted. This is a comma-separated list (and URL-encoded) |
No |
| Goal count identifier(s) |
gcn | int | The parameter name is gcn, where n is a positive integer; e.g., "gc1" or "gc4". The value of each parameter is an integer value in the range -16384 to 16384. Currently, only gc1 through gc4 are supported. All other values for n will be discarded |
No |
Examples:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345&gc1=12
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc1=12
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc2=‐4
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc1=12&gc4=3
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc1=12
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc2=‐4
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/gci/?s=12345%2C67890&gc1=12&gc4=3
Message type: mtu
Status: Active
Description: This message provides information for incrementing monetization value for individual users.
Variables:
Examples:
Status: Active
Description: This message provides information for incrementing monetization value for individual users.
Variables:
| Name | Parameter | Type | Description | Optional |
| UID |
s | array | The
UID(s) of the user(s) for which goals count increments are being
submitted. This is a comma-separated list (and URL-encoded) |
No |
| value |
v |
int | The revenue generated for the user with UID in cents ($0.01 or 1/100th of $1), NOT in dollars The monetization value for the user(s) listed in the UID parameter are incremented by this value. NOTE: displayed values in the UI will be divided by 100. Thus if you want to add, for example, 50 cents of value to a user, set 'v' to 50. If you want to add $1.50, set 'v' to 150. If you want to indicate a credit was issued to the the user, use a negative number for 'v'. The largest allowed value for 'v' is 1000000 (1M). Values with anything other than digits 0 through 9 and a possible leading '-' will be ignored (the value should not contain any commas or periods). |
No |
Examples:
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mtu/?s=12345&v=120
api.geo.kontagent.net/api/v1/01234567890123456789012345678901/mtu/?s=12345%2C67890&v=120
Unique tracking tags are used to match a message (invite, notification, etc.) send event to a message response. In order to properly match responses to sent messages, response calls must have the exact same unique tag as the send call.
16/32-char UUIDs (Universally Unique Identifiers) in a string format are used for tracking tags. There are no dashes used in the tracking tags and the tags should only consist of hexadecimal digits.
Any unique 32 character string will work here. There are a number of ways to generate these unique tags. Here are some examples (where the "+" operator indicates appending of strings):
- Millisecond timestamp + uid + random number
- 32 random chars
- uid + random numbers
For proper reporting, it is important that the tag for each send event is unique.
Example for an Invite Sent/Response Pair:
Invite Sent Call: api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/ins/?s=123&r=456%2C789&u=9a3d9332b31632a0
Invite Sent Unique Tag: 9a3d9332b31632a0
Invite Response Call: api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/inr/?r=456&i=1&u=9a3d9332b31632a
Invite Response Unique Tag: 9a3d9332b31632a0
Notice here that the unique tag of the invite sent and invite response match so that the response event can be tracked back to the orignal sent message.
Deprecated Message Formats
This section contains descriptions of deprecated message formats. This information is merely provided for historical reasons and the messages should no longer be used.
Feed Post
Message type: fdpStatus: Deprecated
Description: This message is sent when a feed post is generated by a user's actions in an application.
Variables:
| Name | Parameter | Type | Description | Optional |
| Poster UID |
s | int | The UID of the user posting the feed |
No |
| Template ID |
t | int | Template ID used in the post. Another call is used to define mappings between template IDs and contents |
Yes |
| Post type |
pt | int | The type of feed post: 1. Story 2. Action 3. Templatized action |
Yes |
| Type | tu | char(16) | Fixed value "fdp" |
No |
| Subtype 1 |
st1 | char(16) | Invite subtype 1 |
Yes |
| Subtype 2 |
st2 | char(16) | Invite subtype 2 |
Yes |
Example:
api.geo.kontagent.net/api/v1/0123456789abcdef0123456789abcdef/fdp/?s=456&t=12&y=3