Skip to content

Instantly share code, notes, and snippets.

@ptone

ptone/convore-api-notes.rst

Created March 23, 2011 20:55
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save ptone/883947 to your computer and use it in GitHub Desktop.
Save ptone/883947 to your computer and use it in GitHub Desktop.
Download ZIP
Some minimal documentation and examples of the Convore Live API data
Raw
convore-api-notes.rst

Covore live API: message kinds

  • message
  • message-delete
  • topic
  • topic-delete
  • topic-rename
  • login
  • logout
  • star
  • unstar
  • read
  • mention
  • direct-message

message

sample:

{u'_id': u'9a529200-5580-11e0-a4f2-4040006c4e80',
u'_ts': 1300907165.4393499,
u'date_created': 1300907165.3859799,
u'group': u'7266',
u'id': u'419812',
u'kind': u'message',
u'message': u'@ptone yo',
u'stars': [],
u'topic': {u'id': u'14247',
            u'name': u'new topic',
            u'url': u'/ptonetesting/new-topic/'},
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

message-delete

sample:

{u'_id': u'68f3929c-5588-11e0-a4f2-4040006c4e80',
u'_ts': 1300910518.5822289,
u'kind': u'message-delete',
u'message_id': 420198,
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

topic

creator and user seem to alway be identical:

{u'_id': u'49c81dac-5588-11e0-a4f2-4040006c4e80',
u'_ts': 1300910466.2880681,
u'creator': {u'id': u'24211',
            u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
            u'url': u'/users/pholmes/',
            u'username': u'pholmes'},
u'date_created': 1300910466.2737169,
u'date_latest_message': 1300910466.2737279,
u'group': u'7266',
u'id': u'14790',
u'kind': u'topic',
u'name': u'new topic',
u'slug': u'new-topic-1',
u'url': u'/ptonetesting/new-topic-1/',
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

topic-delete

sample:

{u'_id': u'5578dc6a-558b-11e0-92a2-4040f52583dd',
u'_ts': 1300911774.3914981,
u'kind': u'topic-delete',
u'topic_id': u'14790',
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

topic-rename

sample:

{u'_id': u'd9a63f7c-558c-11e0-a4f2-4040006c4e80',
u'_ts': 1300912425.644942,
u'kind': u'topic-rename',
u'post_name': u'aaabbb',
u'pre_name': u'aaa',
u'topic_id': u'14797',
u'user': {u'id': u'1822',
        u'img': u'https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/ptone/',
        u'username': u'ptone'}}

login

group_ids contain list of all groups for user, not just those in common with live user.:

{u'_id': u'a551bf66-5588-11e0-ac93-4040006c4e80',
u'_ts': 1300910619.8572559,
u'group_ids': [u'3504',
                u'100',
                u'5639',
                u'5648',
                u'5203',
                u'5334',
                u'88',
                u'5721',
                u'2780',
                u'3390',
                u'3391'],
u'kind': u'login',
u'user': {u'id': u'9907',
        u'img': u'https://convore2.s3.amazonaws.com/userpics/9907/1297678592.jpg',
        u'url': u'/users/EisFrei/',
        u'username': u'EisFrei'}}

logout

Sent when a connected client has not pinged the live api in >45 seconds. This applies to open browser tabs, mobile device apps, etc, also one logout message is generated for each group the Live user and the logging out user have in common:

{u'_id': u'cbf199d4-5588-11e0-a4f2-4040006c4e80',
u'_ts': 1300910684.663748,
u'group_ids': [u'7266'],
u'kind': u'logout',
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

read

Sent when the Live API user visits a topic, regardless of whether that topic has unread messages or not.

Only sent for logged in user.

Not sent for topics when you click the "mark as read" buttons

Could be considered a "enters topic":

{u'_id': u'4a72edda-5589-11e0-9545-40401bf7af92',
u'_ts': 1300910896.904201,
u'group_id': u'7266',
u'kind': u'read',
u'topic_id': u'14247',
u'unread_count': 1,
u'user': {u'id': u'1822',
        u'img': u'https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/ptone/',
        u'username': u'ptone'}}

star

author of the starred message is at:

message/star/message/user/username

message content of original is at:

message/star/message/message

no group or topic is available for original message, but there is:

message/star/message_url

sample:

{u'_id': u'954f5652-558b-11e0-92a2-4040f52583dd',
u'_ts': 1300911881.4935529,
u'kind': u'star',
u'star': {u'date_created': 1300911881.4754839,
        u'kind': u'star',
        u'message': {u'date_created': 1300856695.985702,
                        u'embeds': [],
                        u'id': u'414512',
                        u'message': u"This is some really cool, relatively long topic that has a fair amount of text that should probably be wrapped on the screen so that it doesn't look really funny in the terminal",
                        u'stars': [{u'date_created': 1300911881.4754839,
                                    u'user': {u'id': u'24211',
                                            u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                                            u'url': u'/users/pholmes/',
                                            u'username': u'pholmes'}}],
                        u'user': {u'id': u'1822',
                                u'img': u'https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                                u'url': u'/users/ptone/',
                                u'username': u'ptone'}},
        u'message_url': u'/ptonetesting/cool-1/414512/',
        u'user': {u'id': u'24211',
                    u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                    u'url': u'/users/pholmes/',
                    u'username': u'pholmes'}},
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

unstar

sample:

{u'_id': u'615ea0c8-559f-11e0-9737-40401bf7af92',
u'_ts': 1300920384.28685,
u'kind': u'unstar',
u'star': {u'date_created': 1300919377.3944709,
        u'kind': u'star',
        u'message': {u'date_created': 1300918417.8884449,
                        u'embeds': [],
                        u'id': u'421341',
                        u'message': u'@ptone sup',
                        u'stars': [{u'date_created': 1300919377.3944709,
                                    u'user': {u'id': u'24211',
                                            u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                                            u'url': u'/users/pholmes/',
                                            u'username': u'pholmes'}}],
                        u'user': {u'id': u'1822',
                                u'img': u'https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                                u'url': u'/users/ptone/',
                                u'username': u'ptone'}},
        u'message_url': u'/pholmestesting/topic-99/421341/',
        u'user': {u'id': u'24211',
                    u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                    u'url': u'/users/pholmes/',
                    u'username': u'pholmes'}},
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

mention

Note that both a regular message and a mention are sent anytime there is a mention.

sample:

{u'_id': u'9a58682e-5580-11e0-a4f2-4040006c4e80',
u'_ts': 1300907165.477591,
u'kind': u'mention',
u'mentioned_user': {u'id': u'1822',
                    u'img': u'https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                    u'url': u'/users/ptone/',
                    u'username': u'ptone'},
u'message': {u'date_created': 1300907165.3859799,
            u'group': u'7266',
            u'id': u'419812',
            u'kind': u'message',
            u'message': u'@ptone yo',
            u'stars': [],
            u'topic': {u'id': u'14247',
                        u'name': u'new topic',
                        u'url': u'/ptonetesting/new-topic/'},
            u'user': {u'id': u'24211',
                        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
                        u'url': u'/users/pholmes/',
                        u'username': u'pholmes'}},
u'topic_id': u'14247',
u'user': {u'id': u'24211',
        u'img': u'https://secure.gravatar.com/avatar/e2db3ae3c6d54d2e0fd588303db376f8/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80',
        u'url': u'/users/pholmes/',
        u'username': u'pholmes'}}

direct-message

sample:

{
    kind: "direct-message"
    _ts: 1302721319.312328
    -
    user: {
        username: "ptone"
        url: "/users/ptone/"
        id: "1822"
        img: https://secure.gravatar.com/avatar/d38343994d650e09acf2861e4b5db41a/?default=https%3A%2F%2Fconvore.com%2Fmedia%2Fimages%2Feric.png&s=80
    }
    date_created: 1302721319.279849
    message: "hey"
    _id: "824b530a-6600-11e0-9737-40401bf7af92"
    id: "1015"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment