Glossary

This is a reference of available data types. Please review the key concepts.

Applications and Tools

Applications and tools allow awe.sm to track the creation method of links. Applications define a collection of tools and an application must have at least one tool.

For example, the awe.sm-powered Facebook Like Button is an application that has 3 display modes. Each display mode has a Tool defined. This allows the efficacy of each display mode and the Like button overall to be measured.

Applications and tools are managed defined through Application Settings. The data is retrievable through the Stats API when with_metadata is set to TRUE.

A tool key is required for link creation. This key can be found and reset in Application Settings.

awesm_id Object

{
    "awesm_id": "awe.sm_5RvlQ",
    "awesm_id_metadata": {
        "awesm_url": "http://awe.sm/5RvlQ",
        "domain": "awe.sm",
        "path": "5RvlQ",
        "created_at": "2011-08-26T15:10:11Z",
        "redirect_url": "http://dealbook.nytimes.com/2011/08/24/behind-the-glittery-web-start-ups-investors-see-other-gold/",
        "original_url": "http://dealbook.nytimes.com/2011/08/24/behind-the-glittery-web-start-ups-investors-see-other-gold/",
        "channel": "twitter",
        "service": "twitter",
        "tool": "awesm-publisher",
        "application": "awesm",
        "parent": "awe.sm_7gT4",
        "sharer_id": "17e9bea0-e98f-012b-399c-12313903be25",
        "username": "jonathan",
        "service_userid": "twitter:13263",
        "service_postid": "twitter:107107582749065216",
        "service_postid_metadata": {
            "reach": "1982",
            "shared_at": "2011-08-26T15:10:12Z"
        },
        "campaign": "demo",
        "campaign_metadata": {
            "name": "Demo",
            "description": ""
        },
        "user_id": null,
        "user_id_metadata": {
            "profile_url": null,
            "icon_url": null,
            "username": null
        },
        "tag": null,
        "notes": null,
        "updated_at": "2011-08-26T15:10:13Z"
    }
}

Services and Channels

Services and channels allow awe.sm to track the specific destination of links. Services define a collection of channels.

For example, a user can share on Facebook via the Like button, Share button, wall post, and private message. Each sharing method has a defined channel. This allows the efficacy of each sharing method and Facebook as a whole to be measured.

Services and channels are managed by awe.sm. If you don't see a channel or service in this list that you think we should add, please contact developers@awe.sm with your request. An unlisted channel may be used at your discretion, but it will not map to a service.

Pass the channel parameter during link creation to track services and channels.

Email

Facebook

LinkedIn

Tumblr

Twitter

YouTube

Last updated 2011-10-18