The Crowd Convergence Display API includes the following fields in our JSON, JSONP and XML formats.

Consumers of the API should tolerate the addition of new fields and variance in field ordering. Not all fields are included in all contexts.


Fields


Widget

Name Type Default Description Example
id Integer - The unique id of the Widget. 12345
name String - The name of the data Widget. Awesome Widget



Items

Name Type Default Description Example
id Integer - The unique id of the Widget. 12345
source_id Integer - The unique identifier given to the item by its source. 320321890377932800
source String - The source location of the item. Twitter
text String NULL The body content of the item. Check out the big screen Twitter Wall!
image_url String NULL The full resolution URL for any image contained in the item. http://distilleryimage5.ak.instagram.com/d82f8cf68f8d11e2ad6922000a1fa410_7.jpg
image_url_small String NULL The low resolution URL for any image contained in the item. http://distilleryimage5.ak.instagram.com/d82f8cf68f8d11e2ad6922000a1fa410_7.jpg
image_width Integer NULL The pixel width of the image. (if available) 1280
image_height Integer NULL The pixel height of the image. (if available)
 720
video_url String NULL The URL for any video contained in the item. http://scontent-a.cdninstagram.com/hphotos-xaf1/t50.2886-16/11006706_334658353407158_1095761570_n.mp4
is_vip Boolean false The VIP status given to this item during moderation. true
is_favourite Boolean false The favourite status given to this item during moderation. false
date_unix Integer - The UNIX timestamp of when the item was published. 1363481978
original_url String NULL The source URL of the item. https://twitter.com/KgaugeloKotelo/status/921349839820075009



User

Name Type Default Description Example
user_name String - The name or personal identifier of the author of the item. Crowd Convergence
user_screen_name String - The unique screen name of the author of the item. crowdconverge
profile_image_url String NULL The full resolution URL for the profile image of the item's author. http://a0.twimg.com//profile_images//2611967789//d03hpetalj5drm6jwo22_reasonably_small.jpg
profile_image_url_small String NULL The low resolution URL for the profile image of the item's author. http://a0.twimg.com//profile_images//2611967789//d03hpetalj5drm6jwo22_reasonably_small.jpg



Location

Name Type Default Description Example
latitude Decimal NULL The latitude from which the item was posted. -75.14310264
longitude Decimal NULL The longitude from which the item was posted. 40.05701649






Structure

The complete schema of the API. JSON, JSONP & XML shared the same schema.


<data>

    <widget>

        <id></id>

        <name></name>

    </widget>

    <items>

        <item>

            <id></id>

            <source_id></source_id>

            <source></source>

            <text></text>

            <image_url/>

            <image_small_url/>

            <video_url>

            <is_vip></is_vip>

            <is_favourite></is_favourite>

            <date_unix></date_unix>

            <user>

                <user_name></user_name>

                <user_screen_name></user_screen_name>

                <profile_image_url></profile_image_url>

                <profile_image_small_url></profile_image_small_url>

            </user>

            <location>

                <latitude>

                <longitude>

            </location>

        </item>

    </items>

</data>