COVERITLIVE API - REPLY/LIST (V. 2.0)

CoveritLive API - reply/list (V. 2.0)

The Request

This method provides a feed of reply items from a particular CoveritLive event.

URL:
https://api.coveritlive.com/remote/2/reply/list
Response Format:
JSON
HTTP Method(s):
GET
API Rate Limited:
true (1 unique request per 5 seconds). Each request is cached based on url parameters for 5 seconds, so do not repeat identical requests more than 1 once every 5 seconds.
In addition to the parameters listed in the Request Parameters section, the reply/list method also includes the following parameters:

Parameter Description Required
event_code The event code for the event for which data is being retreived. Each CiL event that is created is assigned a unique event code that identifies it in the database - The event owner can find this value after creating a new event, by selecting the "altcast_code" which is found in their Viewer Window embed code (e.g. the event code is "46e6cd22b5" in "altcast_code=46e6cd22b5"). This value is also returned by the event/list API method. yes
reply_id The last reply ID at which you received. The request will return all replies after this ID. If no ID is provided, it will return all replies starting at the beginning of the event. no
reply_count Controls the number of replies that are returned. If no value is provided, the last 500 matching replies will be returned in ascending order of creation date. Set reply_count to an integer less than 500 to limit the number of replies returned. If this value is set to an integer greater than 500, only the last 500 matching replies will be returned.

If the reply_id parameter is also included in the request, the reply_count replies directly after the reply with reply_id will be returned. Set reply_count to a negative value to return the reply_count items directly before the reply with reply_id

no

Example - Retrieve the next 25 replies after reply_id 2500


https://api.coveritlive.com/remote/2/reply/list?
event_code=000000000
&token=05c413a1242b409fa91f574cea05072b
&reply_id=2500 
&reply_count=25

This request would retrieve:

  • replies for the event with event_code 000000000 which is accessible to the user identified by token 05c413a1242b409fa91f574cea05072b
  • retrieving 25 replies in the event stream that are directly after (i.e. newer than) the reply with an reply_id of 2500

The Response

The reply data is returned in the data field of a general response. The data returned consists of the following fields:

Field Name Field Value(s) Explanation
type reply Describes the type of this object.
replyID {string} ID of this reply item.
parentItemID {string} Item ID of the item that is reply is associated with.
author_name {string} Display name of the author of the reply. Empty if not applicable.
author_avatar {string} URL of thumbnail image associated with author_name. Empty if none provided. (NOTE: Image size is not guaranteed and may vary depending on image source and type. It is recommended that consumers of the Event Data feed adjust image size appropriately for the destination environment.)
comment {string} Text of the reply.
timestamp {int} Date and time the reply was published - format UNIX timestamp.
time {string} Time item entered as displayed in event using format: HH:MM

Example response to a successful reply/list request:


{
    "result":"success",
    "message":"true",
    "type":"reply",
    "action":"list",
    "version":2,
    "data":[{
        "type":"reply",
        "replyID":"985296",
        "parentItemID":"1251673924",
        "author_name":"Billy The Kid",
        "author_avatar":"http:\/\/cdnmo.coveritlive.com\/media\/avitars\/201404\/avatar_square.jpg",
        "comment":"Great day for a horseback ride",
        "time":"13:10",
        "timestamp":1426180205
        }]
    }
}