Viddy Documentation

/v1/media/:type
/v1/media/channel/:channelName
/v1/media/media_id
/v1/media/media_id/comments
/v1/media/media_id/likes
/v1/media/media_id/tags
/v1/media/media_id/tags/tag_id 

Media Lists - /v1/media/:type

HTTP Verb (GET)

Returns a particular type of media list.  The types of lists that can be returned are popular, trending, following and featured, to be specified in the type parameter.  The default number of results is 20.  The list is organized from newest to oldest. 

Input Parameters

Input

Optional

Description

:type

N

The type of media list.

access_token

N*

Auth token

older_than

Y

if specified, the returned entries will be older than this UTC timestamp.

count

Y

Number of entry to return

start_index

Y

If specified, the returned entries will start from index = start_index.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 

  • id

N

Media id

  • type

N

Media type

  • title

N

Media title

  • thumbnail

N

A media thumbnail object

  • source

N

A url to the media file

  • share

N

A url to link to the web player for the video

  • comment_count

N

Comment count

  • like_count

N

Likes count

  • tag_count

N

Tags  count

  • flag_count

N

Flag count

  • location

N

 

  • name

N

Location name

  • latitude

N

Latitude

  • longitude

N

Longitude

  • altitude

N

Altitude

  • city

N

City

  • state

N

State

  • zip

N

Zip

  • country

N

Country

  • status

N

Status of the user: active or inactive

  • user

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A url to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • packId

N

Production pack used on that video

  • short_url

N

Shortened url to media

  • description

N

Description of the video submitted by creator

  • visibility

N

The visibility of the video: public, private, or trending.

Media Channels - /v1/media/channel/:channelName

HTTP Verb (GET)

Returns the media list for a particular channel. The media list will appear in the same order in which they appear on the channel.  The default number of results is 20.

If the channel does not exist, the media array will be empty. 

Input Parameters

Input

Optional

Description

channelName

N

Name of the channel

user_id

Y

User ID to return the favorites or videos of, if not current user

older_than

Y

If specified, the returned entries will be older than this UTC timestamp.

count

Y

Number of entry to return

start_index

Y

If specified, the returned entries will start from index = start_index.

Output Parameters

Output

Optional

Description

result

N

result code

desc                    

Y

error description if result != 0

medias[]

N

 

  • id

N

Media id

  • type

N

Media type

  • title

N

Media title

  • thumbnail

N

A media thumbnail object

  • source

N

A url to the media file

  • share

N

A url to link to the web player for the video

  • comment_count

N

Comment count

  • like_count

N

Likes count

  • tag_count

N

Tags  count

  • flag_count

N

Flag count

  • location

N

 

  • name

N

Location name

  • latitude

N

Latitude

  • longitude

N

Longitude

  • altitude

N

Altitude

  • city

N

City

  • state

N

State

  • zip

N

Zip

  • country

N

Country

  • status

N

Status of the user: active or inactive

  • user

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A url to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • packId

N

Production pack used on that video

  • short_url

N

Shortened url to media

  • description

N

Description of the video submitted by creator

  • visibility

N

The visibility of the video: public, private, or trending.

  • effectId

N

The ID of the effect that has been applied to the video.

  • fbLocationId

N

The FB location ID

  • duration

N

The duration of the video

 

Media Info - /v1/media/media_id

HTTP Verb (GET)

Returns information for a particular video.  The endpoint returns an array with the information (e.g. title, location) on the particular video.  Use this endpoint if you need information on a single viddy.

This does not return the comments posted for a particular video.  For video comments, see /v1/media/media_id/comments.

Input

Optional

Description

access_token

N

Auth token

media_id

Y

ID of the video whose information is requested

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 

  • id

N

Media id

  • type

N

Media type

  • title

N

Media title

  • thumbnail

N

A media thumbnail object

  • source

N

A url to the media file

  • share

N

A url to link to the web player for the video

  • comment_count

N

Comment count

  • like_count

N

Likes count

  • tag_count

N

Tags  count

  • flag_count

N

Flag count

  • location

N

 

  • name

N

Location name

  • latitude

N

Latitude

  • longitude

N

Longitude

  • altitude

N

Altitude

  • city

N

City

  • state

N

State

  • zip

N

Zip

  • country

N

Country

  • status

N

Status of the user: active or inactive

  • user

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A url to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • packId

N

Production pack used on that video

  • short_url

N

Shortened url to media

  • description

N

Description of the video submitted by creator

  • visibility

N

The visibility of the video: public, private, or trending.

  • effectId

N

The ID of the effect that has been applied to the video.

  • fbLocationId

N

The FB location ID

  • duration

N

The duration of the video

 

HTTP Verb (PUT)

Modifies the media title and description.  This call only works for the authenticated users media items. 

Input

Optional

Description

access_token

N

A valid authority token

media_id

N

ID of the video whose information will be changed

title

Y

The new title for the video

description

Y

The new description for the video

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 

  • id

N

Media id

  • type

N

Media type

  • title

N

Media title

  • thumbnail

N

A media thumbnail object

  • source

N

A url to the media file

  • share

N

A url to link to the web player for the video

  • comment_count

N

Comment count

  • like_count

N

Likes count

  • tag_count

N

Tags  count

  • flag_count

N

Flag count

  • location

N

 

  • name

N

Location name

  • latitude

N

Latitude

  • longitude

N

Longitude

  • altitude

N

Altitude

  • city

N

City

  • state

N

State

  • zip

N

Zip

  • country

N

Country

  • status

N

Status of the user: active or inactive

  • user

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A url to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • packId

N

Production pack used on that video

  • short_url

N

Shortened url to media

  • description

N

Description of the video submitted by creator

  • visibility

N

The visibility of the video: public, private, or trending.

  • effectId

N

The ID of the effect that has been applied to the video.

  • fbLocationId

N

The FB location ID

  • duration

N

The duration of the video

 

Media Comments - /v1/media/media_id/comments

HTTP Verb (GET)

Returns the comments posted to a particular video.  If the return count parameter is unspecified, the most recent 40 comments for the particular video will be returned.  If the video has no comments, an empty media array will be returned.

Input

Optional

Description

access_token

N

Auth token

media_id

Y

Media ID for video on which the comments were posted.

older_than

Y

If specified, the returned entries will be older than this UTC timestamp.

count

Y

Number of entry to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

comments[]

N

 

  • id

N

Comment id

  • media_id

N

Media_id

  • content

N

Comment content

  • user

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A url to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

HTTP Verb (POST)

Posts a comment to a video. Comments can be tagged with the commenter’s location by including the geocode parameter.  The geocode information should be a lat/long pair. The return value will be zero if the comment has been successfully posted.  If there is an error, a description of the error will be returned.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

Comment

N

Comment string to post.

Geocode

Y

String of Lat/Long pair

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

HTTP Verb (DELETE)

Delete a comment from a video. The return value will be zero if the comment does not exist or has been successfully deleted.  If there is an error, a description of the error will be returned.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

comment_id

N

Comment to delete.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

Media Likes - /v1/media/media_id/likes

HTTP Verb (GET)

Returns a list of users that have liked a particular video.  If the return count parameter is unspecified, the most recent 20 likes for the particular video will be returned.  If the video does not have any likes, the user array will be empty. 

Input

Optional

Description

media_id

N

The media ID to return.

older_than

Y

if specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entry to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

users[]

N

 

  • id

N

user ID

  • username

N

username

  • full_name

N

First and last name

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

  • profile

N

A link to the users Viddy profile

  • thumbnail

N

The users profile picture thumbnail object

  • profile_picture

N

The users profile picture object

HTTP Verb (POST)

Like a particular video.  The like parameter determines whether the user likes the video.

The return value will be zero if the call was successful.  If there is an error, a description of the error will be returned.

This parameter can work as a delete call if the parameter is set to false.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

media_id

N

The media_id to post the like to.

like

N

True to like the video, false to unlike the video.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

HTTP Verb (DELETE)

Remove a like from a particular video.

The return value will be zero if the call was successful.  If there is an error, a description of the error will be returned.

This is equivalent to a POST call with the like Boolean set to false.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

media_id

N

The media ID to delete the like from.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

Media Tags - /v1/media/media_id/tags

HTTP Verb (GET)

Returns the media tags for a particular video.  The media tags consist of the tag id, media id, user id, content, & timestamps.  The list of tags is ordered from newest to oldest.

Input

Optional

Description

media_id

N

The media ID to return.

older_than

Y

if specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entry to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

media_tags[]

N

 

  • tag_id

N

Tag ID

  • media_id

N

Media ID

  • user_id

N

User ID

  • content

N

Content Data

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

HTTP Verb (POST)

Adds tags to a video. To add multiple tags, separate the tags in the tags field.  The call will return a list of all tags for the video. 

Input

Optional

Description

access_token

N

A valid authority token

media_id

N

The media ID to post the tag.

tags

N

Tag strings to post to the video.  Multiple tags should be separated with a comma.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

media_tags[]

N

 

  • tag_id

N

Tag ID

  • media_id

N

Media ID

  • user_id

N

User ID

  • content

N

Content Data

  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)

  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)

Media Lists - /v1/media/media_id/tags/tag_id

HTTP Verb (DELETE)

Deletes a tag from a video.  The return value will be zero if the tag does not exist or has been successfully deleted.  If there is an error, a description of the error will be returned.

Input

Optional

Description

access_token

N

A valid authority token

media_id

N

The media ID that is tagged

tag_id

N

The tag ID to delete.

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

2 Comments

  1. shixin2 years ago

    good good good !

  2. grudgematchtv.com9 months ago

    how do i get the ApI key

Please sign in to post a comment.