CircleHD Admin API
Build custom LOB application and awesome integrations with CircleHD API. Contact CircleHD support to enable api.
Version: 0.7.0
BasePath:/api/v0
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
Create Channel (createChannel)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Channel to add.
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"is_public" : true,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 0.80082819046101150206595775671303272247314453125
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created Channel
Channel
default
Unexpected error
Error
Up
delete /channels/{channel_id}
Delete a Channel (deleteChannel)
Path parameters
channel_id (required)
Path Parameter — ID of the Channel . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success if channel is deleted
default
Unexpected error
Error
Up
get /channels/{channel_id}
Channel Management (getChannelById)
Returns the Channel for the given id
Path parameters
channel_id (required)
Path Parameter — ID of the Channel . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"is_public" : true,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 0.80082819046101150206595775671303272247314453125
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Channel Object
Channel
default
Unexpected error
Error
Channel Management (getChannels)
Returns a lists the Channels in the
proper display order.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
owner_id (optional)
Query Parameter — User ID of the Channel owner. format: long
Return type
Example data
Content-Type: application/json
[ {
"image" : "image",
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"is_public" : true,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 0.80082819046101150206595775671303272247314453125
}, {
"image" : "image",
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"is_public" : true,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 0.80082819046101150206595775671303272247314453125
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of Channels
default
Unexpected error
Error
Up
post /channels/{channel_id}
Updates a Channel (updateChannel)
Path parameters
channel_id (required)
Path Parameter — ID of the Channel . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Channel to add.
Return type
Example data
Content-Type: application/json
{
"image" : "image",
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"is_public" : true,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 0.80082819046101150206595775671303272247314453125
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created Channel
Channel
default
Unexpected error
Error
Create Media (createMedia)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Media to add.
Return type
Example data
Content-Type: application/json
{
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created Media
Media
default
Unexpected error
Error
Up
delete /medias/{media_id}
Delete a Media (deleteMedia)
Path parameters
media_id (required)
Path Parameter — ID of the Media . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
owner_id
Media (required)
Body Parameter — Owner id of Media to delete.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success if media is deleted
default
Unexpected error
Error
Media Management (getAllMedias)
Returns a lists the Medias in the
proper display order.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
owner_id (optional)
Query Parameter — User ID of the Media owner. format: long
Return type
Example data
Content-Type: application/json
[ {
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
}, {
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of Medias
default
Unexpected error
Error
Up
get /channels/{channel_id}/medias
Channel Management (getChannelMedias)
Returns the Channel for the given id
Path parameters
channel_id (required)
Path Parameter — ID of the Channel. format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
[ {
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
}, {
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of Medias
default
Unexpected error
Error
Up
get /medias/{media_id}
Media Management (getMediaById)
Returns the Media for the given id
Path parameters
media_id (required)
Path Parameter — ID of the Media . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
{
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Media Object
Media
default
Unexpected error
Error
Up
post /medias/{media_id}
Updates a Media (updateMedia)
Path parameters
media_id (required)
Path Parameter — ID of the Media . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Media to add.
Return type
Example data
Content-Type: application/json
{
"thumbnail" : "thumbnail",
"owner_id" : 1.46581298050294517310021547018550336360931396484375,
"media_id" : 0.80082819046101150206595775671303272247314453125,
"description" : "description",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"title" : "title",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"channel_id" : 6.02745618307040320615897144307382404804229736328125,
"view_count" : 5.962133916683182377482808078639209270477294921875
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created Media
Media
default
Unexpected error
Error
System statistics (getStats)
Returns a summery of usage and statistics
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
{
"media_duration" : 1.46581298050294517310021547018550336360931396484375,
"user_count" : 0.80082819046101150206595775671303272247314453125,
"media_count" : 6.02745618307040320615897144307382404804229736328125,
"media_count_week" : 5.63737665663332876420099637471139430999755859375,
"comment_count_week" : 2.3021358869347654518833223846741020679473876953125,
"user_count_week" : 5.962133916683182377482808078639209270477294921875,
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of Channels
Stats
default
Unexpected error
Error
User Profile (me)
The User Profile endpoint returns information about the User account that has authorized with the application.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
{
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Profile information for a user
User
default
Unexpected error
Error
Create User (createUser)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — User to add.
Return type
Example data
Content-Type: application/json
{
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created User
User
default
Unexpected error
Error
Up
delete /users/{user_id}
Delete a User (deleteUser)
Path parameters
user_id (required)
Path Parameter — ID of the User . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — Owner id of User to delete.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Success if user is deleted
default
Unexpected error
Error
User Management (getAllUsers)
Returns a lists the Users in the
proper display order.
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
owner_id (optional)
Query Parameter — User ID of the User owner. format: long
Return type
Example data
Content-Type: application/json
[ {
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
}, {
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
An array of Users
default
Unexpected error
Error
Updates a User (updateUser)
Path parameters
user_id (required)
Path Parameter — ID of the User . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
Body Parameter — User to add.
Return type
Example data
Content-Type: application/json
{
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Created User
User
default
Unexpected error
Error
User Management (usersUserIdGet)
Returns the User for the given id
Path parameters
user_id (required)
Path Parameter — ID of the User . format: long
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Example data
Content-Type: application/json
{
"user_id" : 0.80082819046101150206595775671303272247314453125,
"last_name" : "last_name",
"created_date" : "2000-01-23T04:56:07.000+00:00",
"modified_date" : "2000-01-23T04:56:07.000+00:00",
"first_name" : "first_name",
"email" : "email",
"picture" : "picture"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
User Object
User
default
Unexpected error
Error
[ Jump to Methods ]
Table of Contents
Channel
-
Error
-
Media
-
Stats
-
User
-
channel_id (optional)
BigDecimal Unique identifier representing a specific Channel format: long
description (optional)
String Description of Channel.
title (optional)
String Display name of Channel.
image (optional)
String Image URL representing the Channel.
media_count (optional)
BigDecimal Count of the medias in the channel. format: long
owner_id (optional)
BigDecimal Owner user id of the media. format: long
is_public (optional)
created_date (optional)
Date Created date of the object. format: date-time
modified_date (optional)
Date Created date of the object. format: date-time
code (optional)
message (optional)
fields (optional)
media_id (optional)
BigDecimal Unique identifier representing a specific Media format: long
title (optional)
description (optional)
String Description of the media.
channel_id (optional)
owner_id (optional)
BigDecimal Owner user id of the media. format: long
thumbnail (optional)
String Thumbnail Image URL of the media.
view_count (optional)
created_date (optional)
Date Created date of the object. format: date-time
modified_date (optional)
Date Created date of the object. format: date-time
user_count (optional)
media_count (optional)
media_duration (optional)
BigDecimal Duration of medias in seconds. format: long
user_count_week (optional)
BigDecimal Count of users in current week. format: long
media_count_week (optional)
BigDecimal Count of medias in current week. format: long
comment_count_week (optional)
BigDecimal Count of comments in current week. format: long
created_date (optional)
Date Created date of the object. format: date-time
modified_date (optional)
Date Created date of the object. format: date-time
user_id (optional)
first_name (optional)
String First name of the User account.
last_name (optional)
String Last name of the User account.
email (optional)
String Email address of the User account
picture (optional)
String Image URL of the User account.
created_date (optional)
Date Created date of the object. format: date-time
modified_date (optional)
Date Created date of the object. format: date-time