http://dev.metrixstream.com/w/api.php?action=feedcontributions&feedformat=atom&user=MetrixAdminMetrixstream - User contributions [en]2026-09-12T17:24:37ZUser contributionsMediaWiki 1.19.1http://dev.metrixstream.com/wiki/Talk:Main_PageTalk:Main Page2014-01-22T18:42:59Z<p>MetrixAdmin: Blanked the page</p>
<hr />
<div></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:48:48Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=signup</code><br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone</code>: the primary phone number for this user<br />
* <code>fax</code>: the primary fax number for this user<br />
* <code>dob</code>: the user's date of birth; this is<br />
* <code>sex</code>: the sex of the user<br />
* <code>description</code>: the bio of the user<br />
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status</code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name</code>: the first name of the billing contact<br />
* <code>billing_last_name</code>: the last name of the billing contact<br />
* <code>billing_company</code>: the company name of the billing contact<br />
* <code>billing_address</code>: the address of the billing contact<br />
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city</code>: the city of the billing contact<br />
* <code>billing_state</code>: the state of the billing contact<br />
* <code>billing_zip</code>: the zip code of the billing contact<br />
* <code>billing_country</code>: the country of the billing contact<br />
* <code>billing_phone</code>: an optional phone number related to the billing contact<br />
* <code>billing_fax</code>: an optional fax number related to the billing contact<br />
* <code>billing_email</code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=logout</code><br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Forgot Password ==<br />
<br />
This API call is responsible for sending a forgot password email to a successful match of a username or email address.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=forgotpassword</code><br />
* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:48:29Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=signup</code><br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone</code>: the primary phone number for this user<br />
* <code>fax</code>: the primary fax number for this user<br />
* <code>dob</code>: the user's date of birth; this is<br />
* <code>sex</code>: the sex of the user<br />
* <code>description</code>: the bio of the user<br />
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status</code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name</code>: the first name of the billing contact<br />
* <code>billing_last_name</code>: the last name of the billing contact<br />
* <code>billing_company</code>: the company name of the billing contact<br />
* <code>billing_address</code>: the address of the billing contact<br />
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city</code>: the city of the billing contact<br />
* <code>billing_state</code>: the state of the billing contact<br />
* <code>billing_zip</code>: the zip code of the billing contact<br />
* <code>billing_country</code>: the country of the billing contact<br />
* <code>billing_phone</code>: an optional phone number related to the billing contact<br />
* <code>billing_fax</code>: an optional fax number related to the billing contact<br />
* <code>billing_email</code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=logout</code><br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Forgot Password ==<br />
<br />
This API call is responsible for sending a forgot password email to a successful match of a username or email address.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:48:11Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=signup</code><br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone</code>: the primary phone number for this user<br />
* <code>fax</code>: the primary fax number for this user<br />
* <code>dob</code>: the user's date of birth; this is<br />
* <code>sex</code>: the sex of the user<br />
* <code>description</code>: the bio of the user<br />
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status</code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name</code>: the first name of the billing contact<br />
* <code>billing_last_name</code>: the last name of the billing contact<br />
* <code>billing_company</code>: the company name of the billing contact<br />
* <code>billing_address</code>: the address of the billing contact<br />
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city</code>: the city of the billing contact<br />
* <code>billing_state</code>: the state of the billing contact<br />
* <code>billing_zip</code>: the zip code of the billing contact<br />
* <code>billing_country</code>: the country of the billing contact<br />
* <code>billing_phone</code>: an optional phone number related to the billing contact<br />
* <code>billing_fax</code>: an optional fax number related to the billing contact<br />
* <code>billing_email</code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
None.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Forgot Password ==<br />
<br />
This API call is responsible for sending a forgot password email to a successful match of a username or email address.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:47:42Z<p>MetrixAdmin: /* Logout */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone</code>: the primary phone number for this user<br />
* <code>fax</code>: the primary fax number for this user<br />
* <code>dob</code>: the user's date of birth; this is<br />
* <code>sex</code>: the sex of the user<br />
* <code>description</code>: the bio of the user<br />
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status</code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name</code>: the first name of the billing contact<br />
* <code>billing_last_name</code>: the last name of the billing contact<br />
* <code>billing_company</code>: the company name of the billing contact<br />
* <code>billing_address</code>: the address of the billing contact<br />
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city</code>: the city of the billing contact<br />
* <code>billing_state</code>: the state of the billing contact<br />
* <code>billing_zip</code>: the zip code of the billing contact<br />
* <code>billing_country</code>: the country of the billing contact<br />
* <code>billing_phone</code>: an optional phone number related to the billing contact<br />
* <code>billing_fax</code>: an optional fax number related to the billing contact<br />
* <code>billing_email</code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
None.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Forgot Password ==<br />
<br />
This API call is responsible for sending a forgot password email to a successful match of a username or email address.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; an email address can also be passed to this same field as a convenience<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code>: this response is returned regardless if the param:username field actually matches a user's username or email address; the reason for this is so that someone can't run a brute force attack and discover all the email addresses that belong to your users</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:43:14Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone</code>: the primary phone number for this user<br />
* <code>fax</code>: the primary fax number for this user<br />
* <code>dob</code>: the user's date of birth; this is<br />
* <code>sex</code>: the sex of the user<br />
* <code>description</code>: the bio of the user<br />
* <code>display_name</code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status</code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name</code>: the first name of the billing contact<br />
* <code>billing_last_name</code>: the last name of the billing contact<br />
* <code>billing_company</code>: the company name of the billing contact<br />
* <code>billing_address</code>: the address of the billing contact<br />
* <code>billing_address2</code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city</code>: the city of the billing contact<br />
* <code>billing_state</code>: the state of the billing contact<br />
* <code>billing_zip</code>: the zip code of the billing contact<br />
* <code>billing_country</code>: the country of the billing contact<br />
* <code>billing_phone</code>: an optional phone number related to the billing contact<br />
* <code>billing_fax</code>: an optional fax number related to the billing contact<br />
* <code>billing_email</code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
None.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:42:07Z<p>MetrixAdmin: /* Signup */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Signup ==<br />
<br />
This API call is responsible for signing up a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>username</code>: the username of the user; this must adhere to the site restrictions for username requirements<br />
* <code>password</code>: the password of the user; this must adhere to the site restrictions for password requirements<br />
* <code>email</code>: the email address of the user; this must be a valid email address and not already claimed by another user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>password2</code>: this can be used to verify the user didn't make a typo mistake with their password choice<br />
* <code>phone<code>: the primary phone number for this user<br />
* <code>fax<code>: the primary fax number for this user<br />
* <code>dob<code>: the user's date of birth; this is<br />
* <code>sex<code>: the sex of the user<br />
* <code>description<code>: the bio of the user<br />
* <code>display_name<code>: the display name of the user; this is a non-unique field and is used for display only<br />
* <code>display_status<code>: the display status of the user; this is common for social websites<br />
* <code>billing_first_name<code>: the first name of the billing contact<br />
* <code>billing_last_name<code>: the last name of the billing contact<br />
* <code>billing_company<code>: the company name of the billing contact<br />
* <code>billing_address<code>: the address of the billing contact<br />
* <code>billing_address2<code>: an optional 2nd line for the address of the billing contact<br />
* <code>billing_city<code>: the city of the billing contact<br />
* <code>billing_state<code>: the state of the billing contact<br />
* <code>billing_zip<code>: the zip code of the billing contact<br />
* <code>billing_country<code>: the country of the billing contact<br />
* <code>billing_phone<code>: an optional phone number related to the billing contact<br />
* <code>billing_fax<code>: an optional fax number related to the billing contact<br />
* <code>billing_email<code>: an optional email related to the billing contact<br />
* <code>attr:user:$name</code>: $name should be replaced by the name of any custom fields that have been created for all user objects; make sure to set the permission of "editable" on each custom field you want the user to be able to specify themselves<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
None.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:22:43Z<p>MetrixAdmin: /* Logout */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
= Signup =<br />
<br />
== Logout ==<br />
<br />
This API call is responsible for logging out a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
None.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:AuthenticationSite:API:Authentication2013-01-09T05:21:19Z<p>MetrixAdmin: /* Login */</p>
<hr />
<div>= Authentication =<br />
<br />
== Login ==<br />
<br />
This API call is responsible for logging in a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
None.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=login</code><br />
* <code>username</code>: the username of the user<br />
* <code>password</code>: the password of the user<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
= Signup =<br />
<br />
= Logout =</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Main_PageMain Page2012-08-30T04:33:01Z<p>MetrixAdmin: /* Site API */</p>
<hr />
<div>Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.<br />
<br />
As always you can email [mailto:support@metrixstream.com support@metrixstream.com] with any of your questions.<br />
<br />
= Site Frontend =<br />
<br />
; [[Site:Frontend:Introduction|Introduction]]<br />
: Everything you need to know to get started making sites.<br />
; [[Site:Frontend:BuildingBlocks|Building Blocks]]<br />
: Learn about the tools at your disposal to build your website.<br />
; [[Site:Frontend:Organization|Organization]]<br />
: Learn how to organize your objects and feature them in the appropriate places.<br />
; [[Site:Frontend:URLParameters|URL Parameters]]<br />
: Learn how to manipulate a webpage via the URL.<br />
; [[Site:Frontend:Faceted Search|Faceted Search]]<br />
: Performing complex searches to find content and profiles.<br />
; [[Site:Frontend:BackendContexts|Backend Contexts]]<br />
: Allows you to request information from the backend.<br />
; [[Site:Frontend:HDFObjects|HDF Objects]]<br />
: Various objects and what information they contain.<br />
; [[Site:Frontend:InternalMacros|Internal Macros]]<br />
: Pre-existing macros provided to help with common tasks.<br />
; [[Site:Frontend:SEOFriendlyURLS|SEO Friendly URLS]]<br />
: Learn how to make SEO friendly URLS.<br />
; [[Site:Frontend:BestPractices|Best Practices]]<br />
: Some simple guidelines on how to make your development easier.<br />
; [[Site:Frontend:Controllers|Controllers]]<br />
: Properly manage all of your functionality across the entire site.<br />
; [[Site:Frontend:Forms|Forms]]<br />
: Different method for how to collect information from the viewer.<br />
; [[Site:Frontend:Macros|Macros]]<br />
: Create macros for common functionality.<br />
; [[Site:Frontend:Modules|Modules]]<br />
: Package a feature in its entirety within the module framework.<br />
<br />
= Site Backend =<br />
<br />
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.<br />
<br />
; [[Site:Backend:Queries|Backend Queries]]<br />
: A list of the supplied backend queries.<br />
<br />
= Site API =<br />
<br />
The API allows modifications to objects through the backend. All API queries are sent through the same URL. It is common to assign this URL to a JavaScript variable that is then passed throughout your code. Make sure to assign this variable in your actual page definition rather than a JavaScript file. This is required because the templating engine is not available in external JavaScript fileds.<br />
<br />
var urls = {<br />
'apiUrl': '<?cs call:getBasePostUrl() ?>'<br />
};<br />
<br />
; [[Site:API:Authentication|Authentication]]<br />
: this includes support for login, signup, and logout functionality.<br />
; [[Site:API:Blocks|Blocks]]<br />
: this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.<br />
; [[Site:API:Comments|Comments]]<br />
: this includes support for adding, editing, and deleting comments.<br />
; [[Site:API:Content|Content]]<br />
: this includes support for adding, editing, and deleting content.<br />
; [[Site:API:Forums|Forums]]<br />
: this includes support for adding, editing, and deleting forums, threads, and replies.<br />
; [[Site:API:Moderate|Moderate]]<br />
: this includes support for what functionality is available to moderators.<br />
; [[Site:API:PCR|Property Change Requests]]<br />
: this includes support for property changes to objects that require approval by an administrator before they go live.<br />
; [[Site:API:Users|Users]]<br />
: this includes support for adding and editing users.<br />
; [[Site:API:UserCookieData|User Cookie Data]]<br />
: this includes support for setting and deleting server side cookies.<br />
; [[Site:API:Wysiwyg|Wysiwyg Editor]]<br />
: this includes support for retrieving the built in Wysiwyg Editor.<br />
<br />
= Background Tasks =<br />
<br />
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.<br />
<br />
More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks.<br />
<br />
= Media Player =<br />
<br />
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.<br />
<br />
; [[MediaPlayer:Macros|Macros]]<br />
: Learn how to place a media player within a webpage.<br />
; [[MediaPlayer:API:Calls|API Calls]]<br />
: The functions available to control the media player.<br />
; [[MediaPlayer:API:Callbacks|API Callbacks]]<br />
: The callbacks that can be registered to intercept certain actions done via the media player.<br />
; [[MediaPlayer:LiveEvents|Live Events]]<br />
: A list of all events available during a live event and how to interact with them.<br />
; [[MediaPlayer:Skins|Skins]]<br />
: A list of available skins for the media player.<br />
; [[MediaPlayer:WMODE|WMODE]]<br />
: An important mode to understand that can effect the media player performance.<br />
<br />
= Custom Integration =<br />
<br />
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.<br />
<br />
; [[Site:Interfaces|Interfaces]]<br />
: Interfaces necessary for custom integration.<br />
; [[Site:Integration|Integration]]<br />
: Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UserCookieDataSite:API:UserCookieData2012-08-30T04:31:08Z<p>MetrixAdmin: Created page with "= User Cookie Data = User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the..."</p>
<hr />
<div>= User Cookie Data =<br />
<br />
User cookie data is essentially what you are used to with a webbrowser, but stored server side. The benefits of storing this data server side include the ability to have them persist across different computers. This means when a user logs in from home and work, the experience will be the same.<br />
<br />
The big difference between a user cookie and a browser cookie, is that a user cookie requires an authenticated session.... meaning no anonymous preferences are supported. Note: you are not forced to choose one or the other, so you can mix and match each solution to fit your requirements.<br />
<br />
== Set User Cookie ==<br />
<br />
This API call is responsible for setting a user cookie.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
An authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=usercookie</code><br />
* <code>verb=set</code><br />
* <code>name</code>: the name of the user cookie.<br />
:: this has a maximum of 48 characters.<br />
* <code>value</code>: the value of the user cookie.<br />
:: this has a maximum of 1000 characters.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
<br />
<br />
== Delete User Cookie ==<br />
<br />
This API call is responsible for deleting a user cookie. The response will still succeed, if the cookie doesn't exist.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
This API call is responsible for setting a user cookie.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=usercookie</code><br />
* <code>verb=del</code><br />
* <code>name</code>: the name of the user cookie.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-22T17:52:21Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blog,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>title</code><br />
* <code>description</code><br />
* <code>access</code><br />
* <code>release_date</code><br />
* <code>event_date</code><br />
* <code>live_host</code><br />
* <code>live_mode</code><br />
* <code>preview_offset</code><br />
* <code>preview_duration</code><br />
* <code>external_id</code><br />
* <code>allow_oversell</code><br />
* <code>price</code><br />
* <code>price1</code><br />
* <code>price2</code><br />
* <code>price3</code><br />
* <code>price4</code><br />
* <code>price_formula</code><br />
* <code>credits_to_own</code><br />
* <code>credits_per_minute</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>review</code><br />
* <code>gift_credits</code><br />
* <code>user</code><br />
* <code>chat_muted</code><br />
* <code>img:selected</code><br />
* <code>img:title</code><br />
* <code>img:position</code><br />
* <code>photo_hint</code><br />
* <code>add:relationship</code><br />
* <code>del:relationship</code><br />
* <code>playlist:media_id</code><br />
* <code>image (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code><br />
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code><br />
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code><br />
* <code>inventory</code><br />
* <code>inventory:stock:quantity</code><br />
* <code>featured_on_content_id</code><br />
* <code>tags</code><br />
* <code>addtag</code><br />
* <code>deletetag</code><br />
* <code>categories</code><br />
* <code>addcategory</code><br />
* <code>deletecategory</code><br />
* <code>label</code><br />
* <code>label_hint</code><br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-22T17:32:16Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>email</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for editing a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=edituser</code><br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_zip</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to this user<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:30:35Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>email</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for editing a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=edituser</code><br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to this user<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:30:12Z<p>MetrixAdmin: /* Edit User */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for editing a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=edituser</code><br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to this user<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:29:53Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for updating a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=edituser</code><br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to this user<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:29:29Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for updating a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=updateuser</code><br />
* <code>contentId</code>: the id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to this user<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:29:05Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>title</code><br />
* <code>description</code><br />
* <code>access</code><br />
* <code>release_date</code><br />
* <code>event_date</code><br />
* <code>live_host</code><br />
* <code>live_mode</code><br />
* <code>preview_offset</code><br />
* <code>preview_duration</code><br />
* <code>external_id</code><br />
* <code>allow_oversell</code><br />
* <code>price</code><br />
* <code>price1</code><br />
* <code>price2</code><br />
* <code>price3</code><br />
* <code>price4</code><br />
* <code>price_formula</code><br />
* <code>credits_to_own</code><br />
* <code>credits_per_minute</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>review</code><br />
* <code>gift_credits</code><br />
* <code>user</code><br />
* <code>chat_muted</code><br />
* <code>img:selected</code><br />
* <code>img:title</code><br />
* <code>img:position</code><br />
* <code>photo_hint</code><br />
* <code>add:relationship</code><br />
* <code>del:relationship</code><br />
* <code>playlist:media_id</code><br />
* <code>image (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code><br />
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code><br />
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code><br />
* <code>inventory</code><br />
* <code>inventory:stock:quantity</code><br />
* <code>featured_on_content_id</code><br />
* <code>tags</code><br />
* <code>addtag</code><br />
* <code>deletetag</code><br />
* <code>categories</code><br />
* <code>addcategory</code><br />
* <code>deletecategory</code><br />
* <code>label</code><br />
* <code>label_hint</code><br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:28:37Z<p>MetrixAdmin: /* Successful Response */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for updating a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=updateuser</code><br />
* <code>contentId</code>: the id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:28:30Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for updating a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=updateuser</code><br />
* <code>contentId</code>: the id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:26:26Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content<br />
:: replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>title</code><br />
* <code>description</code><br />
* <code>access</code><br />
* <code>release_date</code><br />
* <code>event_date</code><br />
* <code>live_host</code><br />
* <code>live_mode</code><br />
* <code>preview_offset</code><br />
* <code>preview_duration</code><br />
* <code>external_id</code><br />
* <code>allow_oversell</code><br />
* <code>price</code><br />
* <code>price1</code><br />
* <code>price2</code><br />
* <code>price3</code><br />
* <code>price4</code><br />
* <code>price_formula</code><br />
* <code>credits_to_own</code><br />
* <code>credits_per_minute</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>review</code><br />
* <code>gift_credits</code><br />
* <code>user</code><br />
* <code>chat_muted</code><br />
* <code>img:selected</code><br />
* <code>img:title</code><br />
* <code>img:position</code><br />
* <code>photo_hint</code><br />
* <code>add:relationship</code><br />
* <code>del:relationship</code><br />
* <code>playlist:media_id</code><br />
* <code>image (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code><br />
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code><br />
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code><br />
* <code>inventory</code><br />
* <code>inventory:stock:quantity</code><br />
* <code>featured_on_content_id</code><br />
* <code>tags</code><br />
* <code>addtag</code><br />
* <code>deletetag</code><br />
* <code>categories</code><br />
* <code>addcategory</code><br />
* <code>deletecategory</code><br />
* <code>label</code><br />
* <code>label_hint</code><br />
* <code>cst_*</code>: custom fields related to content* <code> replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:25:29Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>title</code><br />
* <code>description</code><br />
* <code>access</code><br />
* <code>release_date</code><br />
* <code>event_date</code><br />
* <code>live_host</code><br />
* <code>live_mode</code><br />
* <code>preview_offset</code><br />
* <code>preview_duration</code><br />
* <code>external_id</code><br />
* <code>allow_oversell</code><br />
* <code>price</code><br />
* <code>price1</code><br />
* <code>price2</code><br />
* <code>price3</code><br />
* <code>price4</code><br />
* <code>price_formula</code><br />
* <code>credits_to_own</code><br />
* <code>credits_per_minute</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>review</code><br />
* <code>gift_credits</code><br />
* <code>user</code><br />
* <code>chat_muted</code><br />
* <code>img:selected</code><br />
* <code>img:title</code><br />
* <code>img:position</code><br />
* <code>photo_hint</code><br />
* <code>add:relationship</code><br />
* <code>del:relationship</code><br />
* <code>playlist:media_id</code><br />
* <code>image (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code><br />
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code><br />
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code><br />
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code><br />
* <code>inventory</code><br />
* <code>inventory:stock:quantity</code><br />
* <code>featured_on_content_id</code><br />
* <code>tags</code><br />
* <code>addtag</code><br />
* <code>deletetag</code><br />
* <code>categories</code><br />
* <code>addcategory</code><br />
* <code>deletecategory</code><br />
* <code>label</code><br />
* <code>label_hint</code><br />
* <code>cst_*</code>: custom fields related to content* <code> replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:24:33Z<p>MetrixAdmin: /* Successful Response */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>properties</code><br />
** <code>pending</code><br />
** <code>approved</code></div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:23:56Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=editcontent</code><br />
* <code>contentId</code>: the id of the content item<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:23:30Z<p>MetrixAdmin: /* Successful Response */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>contentId</code>: the id of the newly created content item<br />
** <code>canonicalId</code>: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:22:40Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=addcontent</code><br />
* <code>type</code>: blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
* <code>title</code>: the content item title; no more than 1000 characters<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T05:21:54Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>description</code>: the content item description; no more than 65k characters<br />
* <code>release_date</code>: the release date of this content item<br />
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
* <code>credits_to_own</code>: the current amount of credits to purchase this item.<br />
* <code>price</code>: the cash value of this item.<br />
:: only available for types that are not a product or project.<br />
* <code>inventory</code>: only available for types that are event.<br />
* <code>label</code>: will be prefixed by the site's user prefix label.<br />
* <code>addcategory</code>: an array of category ids<br />
* <code>addtag</code>: an array of tags<br />
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.<br />
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.<br />
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.<br />
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.<br />
* <code>cst_*</code>: custom fields related to content; replace the * with the appropriate custom field name<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:19:35Z<p>MetrixAdmin: /* Edit Content */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit User ==<br />
<br />
This API call is responsible for updating a user object.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=updateuser</code><br />
* <code>contentId</code>: the id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
* <code>user</code>: the username of the user being updated.<br />
:: this parameter is only available if the authenticated user is an Administrator.<br />
* <code>username</code><br />
* <code>password</code><br />
* <code>email</code><br />
* <code>newsletter</code><br />
* <code>external_id</code><br />
* <code>phone</code><br />
* <code>fax</code><br />
* <code>dob</code><br />
* <code>dob_day</code><br />
* <code>dob_month</code><br />
* <code>dob_year</code><br />
* <code>description</code><br />
* <code>display_name</code><br />
* <code>display_status</code><br />
* <code>lang</code><br />
* <code>sex</code><br />
* <code>relationship</code><br />
* <code>interests</code><br />
* <code>activities</code><br />
* <code>music</code><br />
* <code>tv</code><br />
* <code>books</code><br />
* <code>location</code><br />
* <code>hometown</code><br />
* <code>change_username</code><br />
* <code>allow_login</code><br />
* <code>price_level</code><br />
* <code>billing_fname</code><br />
* <code>billing_lname</code><br />
* <code>billing_company</code><br />
* <code>billing_address</code><br />
* <code>billing_address2</code><br />
* <code>billing_city</code><br />
* <code>billing_state</code><br />
* <code>billing_country</code><br />
* <code>billing_email</code><br />
* <code>billing_phone</code><br />
* <code>billing_fax</code><br />
* <code>shipping_fname</code><br />
* <code>shipping_lname</code><br />
* <code>shipping_company</code><br />
* <code>shipping_address</code><br />
* <code>shipping_address2</code><br />
* <code>shipping_city</code><br />
* <code>shipping_state</code><br />
* <code>shipping_zip</code><br />
* <code>shipping_country</code><br />
* <code>shipping_email</code><br />
* <code>shipping_phone</code><br />
* <code>shipping_fax</code><br />
* <code>bank_name</code><br />
* <code>bank_address</code><br />
* <code>bank_address2</code><br />
* <code>bank_city</code><br />
* <code>bank_state</code><br />
* <code>bank_zip</code><br />
* <code>bank_country</code><br />
* <code>bank_account</code><br />
* <code>bank_routing</code><br />
* <code>bank_swift</code><br />
* <code>bank_phone</code><br />
* <code>bank_iban</code><br />
* <code>review</code><br />
* <code>status</code><br />
* <code>commission_ppm_percentage</code><br />
* <code>commission_pto_percentage</code><br />
* <code>commission_gift_percentage</code><br />
* <code>commission_bandwidth_percentage</code><br />
* <code>activity_summary_duration_secs</code><br />
<br />
* <code></code><br />
* <code></code><br />
* <code></code><br />
* <code></code><br />
* <code>cst_*</code><br />
<br />
<br />
<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T05:00:11Z<p>MetrixAdmin: /* Required Parameters */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
* <code>action=user</code><br />
* <code>verb=adduser</code><br />
* <code>username</code>: the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T04:59:09Z<p>MetrixAdmin: /* Successful Response */</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=user<br />
;verb=adduser<br />
;username<br />
:the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
* <code>status=ok</code><br />
* <code>item</code><br />
** <code>user</code><br />
*** <code>id</code>: the id of the user<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:UsersSite:API:Users2012-08-21T04:57:19Z<p>MetrixAdmin: Created page with "= Users = == Add User == This API call is responsible for creating a user. === Authentication Restrictions === Administrator only. === Required Parameters === ;action=us..."</p>
<hr />
<div>= Users =<br />
<br />
== Add User ==<br />
<br />
This API call is responsible for creating a user.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Administrator only.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=user<br />
;verb=adduser<br />
;username<br />
:the username of the user<br />
<br />
=== Optional Parameters ===<br />
<br />
;email<br />
;commission_pto_percentage<br />
;commission_ppm_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;activity_summary_duration_secs<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;user<br />
<br />
::;id<br />
::: the id of the user.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Main_PageMain Page2012-08-21T04:08:01Z<p>MetrixAdmin: /* Site API */</p>
<hr />
<div>Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.<br />
<br />
As always you can email [mailto:support@metrixstream.com support@metrixstream.com] with any of your questions.<br />
<br />
= Site Frontend =<br />
<br />
; [[Site:Frontend:Introduction|Introduction]]<br />
: Everything you need to know to get started making sites.<br />
; [[Site:Frontend:BuildingBlocks|Building Blocks]]<br />
: Learn about the tools at your disposal to build your website.<br />
; [[Site:Frontend:Organization|Organization]]<br />
: Learn how to organize your objects and feature them in the appropriate places.<br />
; [[Site:Frontend:URLParameters|URL Parameters]]<br />
: Learn how to manipulate a webpage via the URL.<br />
; [[Site:Frontend:Faceted Search|Faceted Search]]<br />
: Performing complex searches to find content and profiles.<br />
; [[Site:Frontend:BackendContexts|Backend Contexts]]<br />
: Allows you to request information from the backend.<br />
; [[Site:Frontend:HDFObjects|HDF Objects]]<br />
: Various objects and what information they contain.<br />
; [[Site:Frontend:InternalMacros|Internal Macros]]<br />
: Pre-existing macros provided to help with common tasks.<br />
; [[Site:Frontend:SEOFriendlyURLS|SEO Friendly URLS]]<br />
: Learn how to make SEO friendly URLS.<br />
; [[Site:Frontend:BestPractices|Best Practices]]<br />
: Some simple guidelines on how to make your development easier.<br />
; [[Site:Frontend:Controllers|Controllers]]<br />
: Properly manage all of your functionality across the entire site.<br />
; [[Site:Frontend:Forms|Forms]]<br />
: Different method for how to collect information from the viewer.<br />
; [[Site:Frontend:Macros|Macros]]<br />
: Create macros for common functionality.<br />
; [[Site:Frontend:Modules|Modules]]<br />
: Package a feature in its entirety within the module framework.<br />
<br />
= Site Backend =<br />
<br />
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.<br />
<br />
; [[Site:Backend:Queries|Backend Queries]]<br />
: A list of the supplied backend queries.<br />
<br />
= Site API =<br />
<br />
The API allows modifications to objects through the backend. All API queries are sent through the same URL. It is common to assign this URL to a JavaScript variable that is then passed throughout your code. Make sure to assign this variable in your actual page definition rather than a JavaScript file. This is required because the templating engine is not available in external JavaScript fileds.<br />
<br />
var urls = {<br />
'apiUrl': '<?cs call:getBasePostUrl() ?>'<br />
};<br />
<br />
; [[Site:API:Authentication|Authentication]]<br />
: this includes support for login, signup, and logout functionality.<br />
; [[Site:API:Blocks|Blocks]]<br />
: this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.<br />
; [[Site:API:Comments|Comments]]<br />
: this includes support for adding, editing, and deleting comments.<br />
; [[Site:API:Content|Content]]<br />
: this includes support for adding, editing, and deleting content.<br />
; [[Site:API:Forums|Forums]]<br />
: this includes support for adding, editing, and deleting forums, threads, and replies.<br />
; [[Site:API:Moderate|Moderate]]<br />
: this includes support for what functionality is available to moderators.<br />
; [[Site:API:PCR|Property Change Requests]]<br />
: this includes support for property changes to objects that require approval by an administrator before they go live.<br />
; [[Site:API:Users|Users]]<br />
: this includes support for adding and editing users.<br />
; [[Site:API:Wysiwyg|Wysiwyg Editor]]<br />
: this includes support for retrieving the built in Wysiwyg Editor.<br />
<br />
= Background Tasks =<br />
<br />
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.<br />
<br />
More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks.<br />
<br />
= Media Player =<br />
<br />
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.<br />
<br />
; [[MediaPlayer:Macros|Macros]]<br />
: Learn how to place a media player within a webpage.<br />
; [[MediaPlayer:API:Calls|API Calls]]<br />
: The functions available to control the media player.<br />
; [[MediaPlayer:API:Callbacks|API Callbacks]]<br />
: The callbacks that can be registered to intercept certain actions done via the media player.<br />
; [[MediaPlayer:LiveEvents|Live Events]]<br />
: A list of all events available during a live event and how to interact with them.<br />
; [[MediaPlayer:Skins|Skins]]<br />
: A list of available skins for the media player.<br />
; [[MediaPlayer:WMODE|WMODE]]<br />
: An important mode to understand that can effect the media player performance.<br />
<br />
= Custom Integration =<br />
<br />
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.<br />
<br />
; [[Site:Interfaces|Interfaces]]<br />
: Interfaces necessary for custom integration.<br />
; [[Site:Integration|Integration]]<br />
: Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Main_PageMain Page2012-08-21T04:07:03Z<p>MetrixAdmin: /* Site API */</p>
<hr />
<div>Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.<br />
<br />
As always you can email [mailto:support@metrixstream.com support@metrixstream.com] with any of your questions.<br />
<br />
= Site Frontend =<br />
<br />
; [[Site:Frontend:Introduction|Introduction]]<br />
: Everything you need to know to get started making sites.<br />
; [[Site:Frontend:BuildingBlocks|Building Blocks]]<br />
: Learn about the tools at your disposal to build your website.<br />
; [[Site:Frontend:Organization|Organization]]<br />
: Learn how to organize your objects and feature them in the appropriate places.<br />
; [[Site:Frontend:URLParameters|URL Parameters]]<br />
: Learn how to manipulate a webpage via the URL.<br />
; [[Site:Frontend:Faceted Search|Faceted Search]]<br />
: Performing complex searches to find content and profiles.<br />
; [[Site:Frontend:BackendContexts|Backend Contexts]]<br />
: Allows you to request information from the backend.<br />
; [[Site:Frontend:HDFObjects|HDF Objects]]<br />
: Various objects and what information they contain.<br />
; [[Site:Frontend:InternalMacros|Internal Macros]]<br />
: Pre-existing macros provided to help with common tasks.<br />
; [[Site:Frontend:SEOFriendlyURLS|SEO Friendly URLS]]<br />
: Learn how to make SEO friendly URLS.<br />
; [[Site:Frontend:BestPractices|Best Practices]]<br />
: Some simple guidelines on how to make your development easier.<br />
; [[Site:Frontend:Controllers|Controllers]]<br />
: Properly manage all of your functionality across the entire site.<br />
; [[Site:Frontend:Forms|Forms]]<br />
: Different method for how to collect information from the viewer.<br />
; [[Site:Frontend:Macros|Macros]]<br />
: Create macros for common functionality.<br />
; [[Site:Frontend:Modules|Modules]]<br />
: Package a feature in its entirety within the module framework.<br />
<br />
= Site Backend =<br />
<br />
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.<br />
<br />
; [[Site:Backend:Queries|Backend Queries]]<br />
: A list of the supplied backend queries.<br />
<br />
= Site API =<br />
<br />
The API allows modifications to objects through the backend. All API queries are sent through the same URL. It is common to assign this URL to a JavaScript variable that is then passed throughout your code.<br />
<br />
var urls = {<br />
'apiUrl': '<?cs call:getBasePostUrl() ?>'<br />
};<br />
<br />
; [[Site:API:Authentication|Authentication]]<br />
: this includes support for login, signup, and logout functionality.<br />
; [[Site:API:Blocks|Blocks]]<br />
: this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.<br />
; [[Site:API:Comments|Comments]]<br />
: this includes support for adding, editing, and deleting comments.<br />
; [[Site:API:Content|Content]]<br />
: this includes support for adding, editing, and deleting content.<br />
; [[Site:API:Forums|Forums]]<br />
: this includes support for adding, editing, and deleting forums, threads, and replies.<br />
; [[Site:API:Moderate|Moderate]]<br />
: this includes support for what functionality is available to moderators.<br />
; [[Site:API:PCR|Property Change Requests]]<br />
: this includes support for property changes to objects that require approval by an administrator before they go live.<br />
; [[Site:API:Users|Users]]<br />
: this includes support for adding and editing users.<br />
; [[Site:API:Wysiwyg|Wysiwyg Editor]]<br />
: this includes support for retrieving the built in Wysiwyg Editor.<br />
<br />
= Background Tasks =<br />
<br />
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.<br />
<br />
More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks.<br />
<br />
= Media Player =<br />
<br />
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.<br />
<br />
; [[MediaPlayer:Macros|Macros]]<br />
: Learn how to place a media player within a webpage.<br />
; [[MediaPlayer:API:Calls|API Calls]]<br />
: The functions available to control the media player.<br />
; [[MediaPlayer:API:Callbacks|API Callbacks]]<br />
: The callbacks that can be registered to intercept certain actions done via the media player.<br />
; [[MediaPlayer:LiveEvents|Live Events]]<br />
: A list of all events available during a live event and how to interact with them.<br />
; [[MediaPlayer:Skins|Skins]]<br />
: A list of available skins for the media player.<br />
; [[MediaPlayer:WMODE|WMODE]]<br />
: An important mode to understand that can effect the media player performance.<br />
<br />
= Custom Integration =<br />
<br />
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.<br />
<br />
; [[Site:Interfaces|Interfaces]]<br />
: Interfaces necessary for custom integration.<br />
; [[Site:Integration|Integration]]<br />
: Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Main_PageMain Page2012-08-21T04:05:42Z<p>MetrixAdmin: /* Site API */</p>
<hr />
<div>Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.<br />
<br />
As always you can email [mailto:support@metrixstream.com support@metrixstream.com] with any of your questions.<br />
<br />
= Site Frontend =<br />
<br />
; [[Site:Frontend:Introduction|Introduction]]<br />
: Everything you need to know to get started making sites.<br />
; [[Site:Frontend:BuildingBlocks|Building Blocks]]<br />
: Learn about the tools at your disposal to build your website.<br />
; [[Site:Frontend:Organization|Organization]]<br />
: Learn how to organize your objects and feature them in the appropriate places.<br />
; [[Site:Frontend:URLParameters|URL Parameters]]<br />
: Learn how to manipulate a webpage via the URL.<br />
; [[Site:Frontend:Faceted Search|Faceted Search]]<br />
: Performing complex searches to find content and profiles.<br />
; [[Site:Frontend:BackendContexts|Backend Contexts]]<br />
: Allows you to request information from the backend.<br />
; [[Site:Frontend:HDFObjects|HDF Objects]]<br />
: Various objects and what information they contain.<br />
; [[Site:Frontend:InternalMacros|Internal Macros]]<br />
: Pre-existing macros provided to help with common tasks.<br />
; [[Site:Frontend:SEOFriendlyURLS|SEO Friendly URLS]]<br />
: Learn how to make SEO friendly URLS.<br />
; [[Site:Frontend:BestPractices|Best Practices]]<br />
: Some simple guidelines on how to make your development easier.<br />
; [[Site:Frontend:Controllers|Controllers]]<br />
: Properly manage all of your functionality across the entire site.<br />
; [[Site:Frontend:Forms|Forms]]<br />
: Different method for how to collect information from the viewer.<br />
; [[Site:Frontend:Macros|Macros]]<br />
: Create macros for common functionality.<br />
; [[Site:Frontend:Modules|Modules]]<br />
: Package a feature in its entirety within the module framework.<br />
<br />
= Site Backend =<br />
<br />
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.<br />
<br />
; [[Site:Backend:Queries|Backend Queries]]<br />
: A list of the supplied backend queries.<br />
<br />
= Site API =<br />
<br />
The API allows modifications to objects through the backend. All API queries are sent through the same URL.<br />
<br />
<?cs call:getBasePostUrl() ?><br />
<br />
; [[Site:API:Authentication|Authentication]]<br />
: this includes support for login, signup, and logout functionality.<br />
; [[Site:API:Blocks|Blocks]]<br />
: this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.<br />
; [[Site:API:Comments|Comments]]<br />
: this includes support for adding, editing, and deleting comments.<br />
; [[Site:API:Content|Content]]<br />
: this includes support for adding, editing, and deleting content.<br />
; [[Site:API:Forums|Forums]]<br />
: this includes support for adding, editing, and deleting forums, threads, and replies.<br />
; [[Site:API:Moderate|Moderate]]<br />
: this includes support for what functionality is available to moderators.<br />
; [[Site:API:PCR|Property Change Requests]]<br />
: this includes support for property changes to objects that require approval by an administrator before they go live.<br />
; [[Site:API:Users|Users]]<br />
: this includes support for adding and editing users.<br />
; [[Site:API:Wysiwyg|Wysiwyg Editor]]<br />
: this includes support for retrieving the built in Wysiwyg Editor.<br />
<br />
= Background Tasks =<br />
<br />
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.<br />
<br />
More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks.<br />
<br />
= Media Player =<br />
<br />
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.<br />
<br />
; [[MediaPlayer:Macros|Macros]]<br />
: Learn how to place a media player within a webpage.<br />
; [[MediaPlayer:API:Calls|API Calls]]<br />
: The functions available to control the media player.<br />
; [[MediaPlayer:API:Callbacks|API Callbacks]]<br />
: The callbacks that can be registered to intercept certain actions done via the media player.<br />
; [[MediaPlayer:LiveEvents|Live Events]]<br />
: A list of all events available during a live event and how to interact with them.<br />
; [[MediaPlayer:Skins|Skins]]<br />
: A list of available skins for the media player.<br />
; [[MediaPlayer:WMODE|WMODE]]<br />
: An important mode to understand that can effect the media player performance.<br />
<br />
= Custom Integration =<br />
<br />
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.<br />
<br />
; [[Site:Interfaces|Interfaces]]<br />
: Interfaces necessary for custom integration.<br />
; [[Site:Integration|Integration]]<br />
: Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T04:04:42Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T04:04:09Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
;cst_*<br />
;custom fields related to content; replace the * with the appropriate custom field name.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;custom fields<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T04:02:54Z<p>MetrixAdmin: /* Successful Response */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;custom fields<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
:;properties<br />
<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T04:02:25Z<p>MetrixAdmin: /* Edit Comment */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Content ==<br />
<br />
This API call is responsible for editing a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=editcontent<br />
;contentId<br />
:The id of the content item.<br />
<br />
=== Optional Parameters ===<br />
<br />
;title<br />
;description<br />
;access<br />
;release_date<br />
;event_date<br />
;live_host<br />
;live_mode<br />
;preview_offset<br />
;preview_duration<br />
;external_id<br />
;allow_oversell<br />
;price<br />
;price1<br />
;price2<br />
;price3<br />
;price4<br />
;price_formula<br />
;credits_to_own<br />
;credits_per_minute<br />
;commission_ppm_percentage<br />
;commission_pto_percentage<br />
;commission_gift_percentage<br />
;commission_bandwidth_percentage<br />
;review<br />
;gift_credits<br />
;user<br />
;chat_muted<br />
;img:selected<br />
;img:title<br />
;img:position<br />
;photo_hint<br />
;add:relationship<br />
;del:relationship<br />
;playlist:media_id<br />
;image (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)<br />
;banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10<br />
;banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo<br />
;banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot<br />
;inventory<br />
;inventory:stock:quantity<br />
;featured_on_content_id<br />
;tags<br />
;addtag<br />
;deletetag<br />
;categories<br />
;addcategory<br />
;deletecategory<br />
;label<br />
;label_hint<br />
;custom fields<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
:;properties<br />
::;pending<br />
::;approved</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T03:50:27Z<p>MetrixAdmin: /* Delete Comment */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Comment ==<br />
<br />
This API call is responsible for editing a comment.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=comment<br />
;verb=editcomment<br />
;commentId<br />
:The id of the comment.<br />
<br />
=== Optional Parameters ===<br />
<br />
;msg<br />
:the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.<br />
;approved=yes|no<br />
:the comment approval state; Only Moderators have access to this field.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T03:49:51Z<p>MetrixAdmin: /* Optional Parameters */</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
:the release date of this content item.<br />
;credits_per_minute<br />
:the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.<br />
;credits_to_own<br />
:the current amount of credits to purchase this item.<br />
;price<br />
:the cash value of this item.<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
;featured_on_content_id<br />
:an advanced feature for featuring products during a live broadcast.<br />
;inventory:stock:quantity<br />
:only available for types that are inventory; initializes stock to this value.<br />
;inventory:stock:external_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:external2_id<br />
:only available for types that are inventory; an optional external_id for this stock.<br />
;inventory:stock:note<br />
:only available for types that are inventory; an optional note for this stock.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Comment ==<br />
<br />
This API call is responsible for editing a comment.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=comment<br />
;verb=editcomment<br />
;commentId<br />
:The id of the comment.<br />
<br />
=== Optional Parameters ===<br />
<br />
;msg<br />
:the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.<br />
;approved=yes|no<br />
:the comment approval state; Only Moderators have access to this field.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
== Delete Comment ==<br />
<br />
This API call is responsible for deleting a comment.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators; Comment owners;<br />
<br />
=== Required Parameters ===<br />
<br />
;action=comment<br />
;verb=delcomment<br />
;commentId<br />
:The id of the comment.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:API:ContentSite:API:Content2012-08-21T03:45:15Z<p>MetrixAdmin: Created page with "= Content = == Add Content == This API call is responsible for creating a content item. === Authentication Restrictions === Any authenticated user. === Required Parameter..."</p>
<hr />
<div>= Content =<br />
<br />
== Add Content ==<br />
<br />
This API call is responsible for creating a content item.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Any authenticated user.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=addcontent<br />
;type<br />
:blob,news,album,inventory,object,product,photoset,project,pledge,playlist,event<br />
;title<br />
:the content item title; no more than 1000 characters.<br />
<br />
=== Optional Parameters ===<br />
<br />
;description<br />
:the content item description; no more than 65k characters.<br />
;release_date<br />
;credits_per_minute<br />
;credits_to_own<br />
;price<br />
:only available for types that are not a product or project.<br />
;inventory<br />
:only available for types that are event.<br />
;label<br />
:will be prefixed by the site's user prefix label.<br />
;addcategory<br />
:an array of category ids<br />
;addtag<br />
:an array of tags<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
;item<br />
<br />
:;contentId<br />
:: the id of the newly created content item;<br />
:;canonicalId<br />
:: the canonical id of the newly created content item.<br />
<br />
== Edit Comment ==<br />
<br />
This API call is responsible for editing a comment.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators and Comment authors.<br />
<br />
=== Required Parameters ===<br />
<br />
;action=comment<br />
;verb=editcomment<br />
;commentId<br />
:The id of the comment.<br />
<br />
=== Optional Parameters ===<br />
<br />
;msg<br />
:the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.<br />
;approved=yes|no<br />
:the comment approval state; Only Moderators have access to this field.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok<br />
<br />
== Delete Comment ==<br />
<br />
This API call is responsible for deleting a comment.<br />
<br />
=== Authentication Restrictions ===<br />
<br />
Moderators; Comment owners;<br />
<br />
=== Required Parameters ===<br />
<br />
;action=comment<br />
;verb=delcomment<br />
;commentId<br />
:The id of the comment.<br />
<br />
=== Successful Response ===<br />
<br />
;status=ok</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:URLParametersSite:Frontend:URLParameters2012-08-18T23:36:32Z<p>MetrixAdmin: /* Introduction */</p>
<hr />
<div>== Introduction ==<br />
<br />
URL Parameters allow you to manipulate the page via the URL. Listed below are explanations on the internal variables that can be referenced.<br />
<br />
=== hdf ===<br />
<br />
Although this parameter doesn't perform any filtering, it is extremely important to remember because it shows you what hdf keys are available to be referenced, which means it is extremely handy in debugging something within the page.<br />
<br />
Example: http://www.example.com/?hdf<br />
<br />
=== page ===<br />
<br />
The page variable directly maps to a particular page within your site.<br />
<br />
Example: http://www.example.com/?page=contact_us<br />
<br />
=== sort ===<br />
<br />
The sort variable specifies how your context results should be sorted. Different choices are available depending on the context referenced.<br />
<br />
Available sorts include: Release Date, Release Date (#2), Release Date (#3), Event Date, Join Date, Title, Creation Date, Id, Canonical Id, # of Views, # of Comments, # of Favorites, # of Ratings, Summed Rating Score, Average Rating Score, Attendance, Decision Date, Activity, Online Status, then Average Rating, and Random.<br />
<br />
Sorts can also be done by custom fields.<br />
<br />
Example: http://www.example.com/?sort=title<br />
<br />
=== order ===<br />
<br />
The order variable allows you to choose how you want your sorting to appear. This variable has 2 possible values: desc (descending order) and asc (ascending order). Normally this variable is omitted from the URL since it is controlled within the context, but for your convenience it is available to change on the fly.<br />
<br />
Example: http://www.example.com/?sort=title&order=asc<br />
<br />
=== limit ===<br />
<br />
The limit variable allows you to request only a subset of the entire context. This essentially means you can page through your context so as to not overwhelm the browser with all the possible data in your system.<br />
<br />
Example: http://www.example.com/?limit=40<br />
<br />
=== off ===<br />
<br />
The off variable allows you to specify an offset in your paging. This is normally used along with limit. <br />
<br />
Example: http://www.example.com/?off=80&limit=40<br />
<br />
=== q ===<br />
<br />
The q variable allows you to search through the page's context results. This search goes through titles, descriptions, and canonical ids.<br />
<br />
Example: http://www.example.com/?q=whatismyname<br />
<br />
=== contentId ===<br />
<br />
The contentId variable allows you to specify which content object you are trying to view. This parameter results in the [[Site:HDFObjects#Content|MS.activeContent]] portion of the HDF object. The contentId variable can either by the numerical id or the canonical id of the content object.<br />
<br />
Example: http://www.example.com/?contentId=myfavoritemovie<br />
<br />
=== user ===<br />
<br />
The user variable allows you to lookup either an account profile or a user profile by their username. Usernames are unique across accounts and users. If a username matches an account, then the [[Site:HDFObjects#Account|MS.activeOwner]] portion of the HDF object will be populated. If a username matches a user, then the [[Site:HDFObjects#User|MS.activeUser]] portion of the HDF object will be populated. This parameter also filters the results of a content context, by only providing content that belongs to the user or account.<br />
<br />
Example: http://www.example.com/?user=myusername<br />
<br />
=== catId ===<br />
<br />
The catId variable lets you specify which category you want to use in your filtering. This variable results in the MS.activeCategory portion of the HDF object.<br />
<br />
Example: http://www.example.com/?catId=37<br />
<br />
=== tag ===<br />
<br />
The tag variable lets you specify which tag you want to use in your filtering. This variable results in the MS.activeTag portion of the HDF object.<br />
<br />
Example: http://www.example.com/?tag=funreading<br />
<br />
=== label ===<br />
<br />
The label variable lets you specify which label you want to use in your filtering. Since labels are considered a security mechanism, only labels whitelisted for a particular page can be referenced via the URL. This variable results in the MS.activeLabel portion of the HDF object.<br />
<br />
Example: http://www.example.com/?label=staff-favorite<br />
<br />
=== type ===<br />
<br />
The type variable lets you perform additional filtering on content related contexts. Available types include: Videos, Photos, Blogs, News, Products, Inventory, Events, Songs, Albums, and Objects.<br />
<br />
Example: http://www.example.com/?type=video<br />
<br />
=== src ===<br />
<br />
The src variable lets you perform additional filtering on video content. Available sources include: Original Videos, Virtual Videos, Live Videos, Everything except Live Videos, Online Now, Offline Now, and Live Archives.<br />
<br />
Example: http://www.example.com/?type=video&src=live<br />
<br />
=== assoc ===<br />
<br />
The assoc variable lets you filter content or profiles by a profile association.<br />
<br />
Example: http://www.example.com/?assoc=Director<br />
<br />
=== rel ===<br />
<br />
The rel variable lets you filter content or profiles by a content relationship.<br />
<br />
Example: http://www.example.com/?rel=has:dvd<br />
<br />
=== year ===<br />
<br />
The year variable lets you filter content by a particular year. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008<br />
<br />
=== month ===<br />
<br />
The month variable lets you filter content by a particular month. This can be used standalone or with the year variable. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008&month=06<br />
<br />
=== hint ===<br />
<br />
The hint variable lets you give hints to the context to perform custom queries. This is normally the result of experimental features and should only be used with guidance by Metrixstream staff.<br />
<br />
=== countrycode, regioncode, city ===<br />
<br />
These variables are used exclusively for the location context.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:URLParametersSite:Frontend:URLParameters2012-08-18T23:36:20Z<p>MetrixAdmin: /* Introduction */</p>
<hr />
<div>== Introduction ==<br />
test<br />
URL Parameters allow you to manipulate the page via the URL. Listed below are explanations on the internal variables that can be referenced.<br />
<br />
=== hdf ===<br />
<br />
Although this parameter doesn't perform any filtering, it is extremely important to remember because it shows you what hdf keys are available to be referenced, which means it is extremely handy in debugging something within the page.<br />
<br />
Example: http://www.example.com/?hdf<br />
<br />
=== page ===<br />
<br />
The page variable directly maps to a particular page within your site.<br />
<br />
Example: http://www.example.com/?page=contact_us<br />
<br />
=== sort ===<br />
<br />
The sort variable specifies how your context results should be sorted. Different choices are available depending on the context referenced.<br />
<br />
Available sorts include: Release Date, Release Date (#2), Release Date (#3), Event Date, Join Date, Title, Creation Date, Id, Canonical Id, # of Views, # of Comments, # of Favorites, # of Ratings, Summed Rating Score, Average Rating Score, Attendance, Decision Date, Activity, Online Status, then Average Rating, and Random.<br />
<br />
Sorts can also be done by custom fields.<br />
<br />
Example: http://www.example.com/?sort=title<br />
<br />
=== order ===<br />
<br />
The order variable allows you to choose how you want your sorting to appear. This variable has 2 possible values: desc (descending order) and asc (ascending order). Normally this variable is omitted from the URL since it is controlled within the context, but for your convenience it is available to change on the fly.<br />
<br />
Example: http://www.example.com/?sort=title&order=asc<br />
<br />
=== limit ===<br />
<br />
The limit variable allows you to request only a subset of the entire context. This essentially means you can page through your context so as to not overwhelm the browser with all the possible data in your system.<br />
<br />
Example: http://www.example.com/?limit=40<br />
<br />
=== off ===<br />
<br />
The off variable allows you to specify an offset in your paging. This is normally used along with limit. <br />
<br />
Example: http://www.example.com/?off=80&limit=40<br />
<br />
=== q ===<br />
<br />
The q variable allows you to search through the page's context results. This search goes through titles, descriptions, and canonical ids.<br />
<br />
Example: http://www.example.com/?q=whatismyname<br />
<br />
=== contentId ===<br />
<br />
The contentId variable allows you to specify which content object you are trying to view. This parameter results in the [[Site:HDFObjects#Content|MS.activeContent]] portion of the HDF object. The contentId variable can either by the numerical id or the canonical id of the content object.<br />
<br />
Example: http://www.example.com/?contentId=myfavoritemovie<br />
<br />
=== user ===<br />
<br />
The user variable allows you to lookup either an account profile or a user profile by their username. Usernames are unique across accounts and users. If a username matches an account, then the [[Site:HDFObjects#Account|MS.activeOwner]] portion of the HDF object will be populated. If a username matches a user, then the [[Site:HDFObjects#User|MS.activeUser]] portion of the HDF object will be populated. This parameter also filters the results of a content context, by only providing content that belongs to the user or account.<br />
<br />
Example: http://www.example.com/?user=myusername<br />
<br />
=== catId ===<br />
<br />
The catId variable lets you specify which category you want to use in your filtering. This variable results in the MS.activeCategory portion of the HDF object.<br />
<br />
Example: http://www.example.com/?catId=37<br />
<br />
=== tag ===<br />
<br />
The tag variable lets you specify which tag you want to use in your filtering. This variable results in the MS.activeTag portion of the HDF object.<br />
<br />
Example: http://www.example.com/?tag=funreading<br />
<br />
=== label ===<br />
<br />
The label variable lets you specify which label you want to use in your filtering. Since labels are considered a security mechanism, only labels whitelisted for a particular page can be referenced via the URL. This variable results in the MS.activeLabel portion of the HDF object.<br />
<br />
Example: http://www.example.com/?label=staff-favorite<br />
<br />
=== type ===<br />
<br />
The type variable lets you perform additional filtering on content related contexts. Available types include: Videos, Photos, Blogs, News, Products, Inventory, Events, Songs, Albums, and Objects.<br />
<br />
Example: http://www.example.com/?type=video<br />
<br />
=== src ===<br />
<br />
The src variable lets you perform additional filtering on video content. Available sources include: Original Videos, Virtual Videos, Live Videos, Everything except Live Videos, Online Now, Offline Now, and Live Archives.<br />
<br />
Example: http://www.example.com/?type=video&src=live<br />
<br />
=== assoc ===<br />
<br />
The assoc variable lets you filter content or profiles by a profile association.<br />
<br />
Example: http://www.example.com/?assoc=Director<br />
<br />
=== rel ===<br />
<br />
The rel variable lets you filter content or profiles by a content relationship.<br />
<br />
Example: http://www.example.com/?rel=has:dvd<br />
<br />
=== year ===<br />
<br />
The year variable lets you filter content by a particular year. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008<br />
<br />
=== month ===<br />
<br />
The month variable lets you filter content by a particular month. This can be used standalone or with the year variable. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008&month=06<br />
<br />
=== hint ===<br />
<br />
The hint variable lets you give hints to the context to perform custom queries. This is normally the result of experimental features and should only be used with guidance by Metrixstream staff.<br />
<br />
=== countrycode, regioncode, city ===<br />
<br />
These variables are used exclusively for the location context.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:URLParametersSite:Frontend:URLParameters2012-08-18T23:34:57Z<p>MetrixAdmin: Reverted edits by 188.92.75.82 (talk) to last revision by MetrixAdmin</p>
<hr />
<div>== Introduction ==<br />
<br />
URL Parameters allow you to manipulate the page via the URL. Listed below are explanations on the internal variables that can be referenced.<br />
<br />
=== hdf ===<br />
<br />
Although this parameter doesn't perform any filtering, it is extremely important to remember because it shows you what hdf keys are available to be referenced, which means it is extremely handy in debugging something within the page.<br />
<br />
Example: http://www.example.com/?hdf<br />
<br />
=== page ===<br />
<br />
The page variable directly maps to a particular page within your site.<br />
<br />
Example: http://www.example.com/?page=contact_us<br />
<br />
=== sort ===<br />
<br />
The sort variable specifies how your context results should be sorted. Different choices are available depending on the context referenced.<br />
<br />
Available sorts include: Release Date, Release Date (#2), Release Date (#3), Event Date, Join Date, Title, Creation Date, Id, Canonical Id, # of Views, # of Comments, # of Favorites, # of Ratings, Summed Rating Score, Average Rating Score, Attendance, Decision Date, Activity, Online Status, then Average Rating, and Random.<br />
<br />
Sorts can also be done by custom fields.<br />
<br />
Example: http://www.example.com/?sort=title<br />
<br />
=== order ===<br />
<br />
The order variable allows you to choose how you want your sorting to appear. This variable has 2 possible values: desc (descending order) and asc (ascending order). Normally this variable is omitted from the URL since it is controlled within the context, but for your convenience it is available to change on the fly.<br />
<br />
Example: http://www.example.com/?sort=title&order=asc<br />
<br />
=== limit ===<br />
<br />
The limit variable allows you to request only a subset of the entire context. This essentially means you can page through your context so as to not overwhelm the browser with all the possible data in your system.<br />
<br />
Example: http://www.example.com/?limit=40<br />
<br />
=== off ===<br />
<br />
The off variable allows you to specify an offset in your paging. This is normally used along with limit. <br />
<br />
Example: http://www.example.com/?off=80&limit=40<br />
<br />
=== q ===<br />
<br />
The q variable allows you to search through the page's context results. This search goes through titles, descriptions, and canonical ids.<br />
<br />
Example: http://www.example.com/?q=whatismyname<br />
<br />
=== contentId ===<br />
<br />
The contentId variable allows you to specify which content object you are trying to view. This parameter results in the [[Site:HDFObjects#Content|MS.activeContent]] portion of the HDF object. The contentId variable can either by the numerical id or the canonical id of the content object.<br />
<br />
Example: http://www.example.com/?contentId=myfavoritemovie<br />
<br />
=== user ===<br />
<br />
The user variable allows you to lookup either an account profile or a user profile by their username. Usernames are unique across accounts and users. If a username matches an account, then the [[Site:HDFObjects#Account|MS.activeOwner]] portion of the HDF object will be populated. If a username matches a user, then the [[Site:HDFObjects#User|MS.activeUser]] portion of the HDF object will be populated. This parameter also filters the results of a content context, by only providing content that belongs to the user or account.<br />
<br />
Example: http://www.example.com/?user=myusername<br />
<br />
=== catId ===<br />
<br />
The catId variable lets you specify which category you want to use in your filtering. This variable results in the MS.activeCategory portion of the HDF object.<br />
<br />
Example: http://www.example.com/?catId=37<br />
<br />
=== tag ===<br />
<br />
The tag variable lets you specify which tag you want to use in your filtering. This variable results in the MS.activeTag portion of the HDF object.<br />
<br />
Example: http://www.example.com/?tag=funreading<br />
<br />
=== label ===<br />
<br />
The label variable lets you specify which label you want to use in your filtering. Since labels are considered a security mechanism, only labels whitelisted for a particular page can be referenced via the URL. This variable results in the MS.activeLabel portion of the HDF object.<br />
<br />
Example: http://www.example.com/?label=staff-favorite<br />
<br />
=== type ===<br />
<br />
The type variable lets you perform additional filtering on content related contexts. Available types include: Videos, Photos, Blogs, News, Products, Inventory, Events, Songs, Albums, and Objects.<br />
<br />
Example: http://www.example.com/?type=video<br />
<br />
=== src ===<br />
<br />
The src variable lets you perform additional filtering on video content. Available sources include: Original Videos, Virtual Videos, Live Videos, Everything except Live Videos, Online Now, Offline Now, and Live Archives.<br />
<br />
Example: http://www.example.com/?type=video&src=live<br />
<br />
=== assoc ===<br />
<br />
The assoc variable lets you filter content or profiles by a profile association.<br />
<br />
Example: http://www.example.com/?assoc=Director<br />
<br />
=== rel ===<br />
<br />
The rel variable lets you filter content or profiles by a content relationship.<br />
<br />
Example: http://www.example.com/?rel=has:dvd<br />
<br />
=== year ===<br />
<br />
The year variable lets you filter content by a particular year. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008<br />
<br />
=== month ===<br />
<br />
The month variable lets you filter content by a particular month. This can be used standalone or with the year variable. This is useful when creating a blog like site which shows various years in the archive menu.<br />
<br />
Example: http://www.example.com/?year=2008&month=06<br />
<br />
=== hint ===<br />
<br />
The hint variable lets you give hints to the context to perform custom queries. This is normally the result of experimental features and should only be used with guidance by Metrixstream staff.<br />
<br />
=== countrycode, regioncode, city ===<br />
<br />
These variables are used exclusively for the location context.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:SEOFriendlyURLSSite:Frontend:SEOFriendlyURLS2012-07-01T23:52:54Z<p>MetrixAdmin: </p>
<hr />
<div>== Introduction ==<br />
<br />
The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are important because it allows your website to be properly indexed by various search engines.<br />
<br />
A simple way to be in compliance with SEO friendliness is to do your best to never use URL parameters. Search engine spiders are expecting a directory type format for your URL.<br />
<br />
=== Not SEO Friendly ===<br />
<br />
http://www.example.com/?page=content&contentId=This.is.my.new.bike<br />
<br />
=== SEO Friendly ===<br />
<br />
http://www.example.com/content/This.is.my.new.bike<br />
<br />
== URL Patterns ==<br />
<br />
Each site is able to specify various URL patterns to customize how it should handle its URL structure. These patterns can be customized by clicking on the "URL PATTERNS" link under each site.<br />
<br />
Each URL Pattern consists of the following:<br />
<br />
; name<br />
: this is a simple name to identify the pattern.<br />
; regex pattern<br />
: this is the actual regular expression used to parse the pattern.<br />
; variable matches<br />
: this is a list of variables that should be matched to the corresponding regular expression.<br />
; defaults<br />
: this is a list of variables that should be implied, if this pattern successfully matches the active URL.<br />
; final<br />
: whether or not to continue onto the next pattern of this pattern successfully matches the active URL.<br />
; layout<br />
: this allows the patterns to be organized based on priority. Sometimes it may matter which patterns get matched first.<br />
<br />
== Example ==<br />
<br />
To match the SEO Friendly URL listed above, you would create the following URL pattern:<br />
<br />
; name<br />
: content 1up<br />
; regex pattern<br />
: /([^\/]+)\/([^\/]+)\/?$/<br />
; variable matches<br />
: page, contentId</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:SEOFriendlyURLSSite:Frontend:SEOFriendlyURLS2012-07-01T23:46:48Z<p>MetrixAdmin: </p>
<hr />
<div>== Introduction ==<br />
<br />
The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are important because it allows your website to be properly indexed by various search engines.<br />
<br />
A simple way to be in compliance with SEO friendliness is to do your best to never use URL parameters. Search engine spiders are expecting a directory type format for your URL.<br />
<br />
=== Not SEO Friendly ===<br />
<br />
http://www.example.com/?page=content&contentId=This.is.my.new.bike<br />
<br />
=== SEO Friendly ===<br />
<br />
http://www.example.com/content/This.is.my.new.bike<br />
<br />
== URL Patterns ==<br />
<br />
Each site is able to specify various URL patterns to customize how it should handle its URL structure. These patterns can be customized by clicking on the "URL PATTERNS" link under each site.<br />
<br />
Each URL Pattern consists of the following:<br />
<br />
; name<br />
: this is a simple name to identify the pattern.<br />
; regex pattern<br />
: this is the actual regular expression used to parse the pattern.<br />
; variable matches<br />
: this is a list of variables that should be matched to the corresponding regular expression.<br />
; defaults<br />
: this is a list of variables that should be implied, if this pattern successfully matches the active URL.<br />
; final<br />
: whether or not to continue onto the next pattern of this pattern successfully matches the active URL.<br />
; layout<br />
: this allows the patterns to be organized based on priority. Sometimes it may matter which patterns get matched first.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:SEOFriendlyURLSSite:Frontend:SEOFriendlyURLS2012-07-01T23:46:28Z<p>MetrixAdmin: </p>
<hr />
<div>== Introduction ==<br />
<br />
The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are important because it allows your website to be properly indexed by various search engines.<br />
<br />
A simple way to be in compliance with SEO friendliness is to do your best to never use URL parameters. Search engine spiders are expecting a directory type format for your URL.<br />
<br />
=== Not SEO Friendly ===<br />
<br />
http://www.example.com/?page=content&contentId=This.is.my.new.bike<br />
<br />
=== SEO Friendly ===<br />
<br />
http://www.example.com/content/This.is.my.new.bike<br />
<br />
=== URL Patterns ===<br />
<br />
Each site is able to specify various URL patterns to customize how it should handle its URL structure. These patterns can be customized by clicking on the "URL PATTERNS" link under each site.<br />
<br />
Each URL Pattern consists of the following:<br />
<br />
; name<br />
: this is a simple name to identify the pattern.<br />
; regex pattern<br />
: this is the actual regular expression used to parse the pattern.<br />
; variable matches<br />
: this is a list of variables that should be matched to the corresponding regular expression.<br />
; defaults<br />
: this is a list of variables that should be implied, if this pattern successfully matches the active URL.<br />
; final<br />
: whether or not to continue onto the next pattern of this pattern successfully matches the active URL.<br />
; layout<br />
: this allows the patterns to be organized based on priority. Sometimes it may matter which patterns get matched first.</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Frontend:SEOFriendlyURLSSite:Frontend:SEOFriendlyURLS2012-07-01T23:33:10Z<p>MetrixAdmin: Created page with "== Introduction == The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are importan..."</p>
<hr />
<div>== Introduction ==<br />
<br />
The format of your URLs actually matter. Depending on how you structure your URLs, your site may or may not be SEO friendly. SEO friendly URLs are important because it allows your website to be properly indexed by various search engines.<br />
<br />
A simple way to be in compliance with SEO friendliness is to do your best to never use URL parameters. Search engine spiders are expecting a directory type format for your URL.<br />
<br />
=== Not SEO Friendly ===<br />
<br />
http://www.example.com/?page=content&contentId=This.is.my.new.bike<br />
<br />
=== SEO Friendly ===<br />
<br />
http://www.example.com/content/This.is.my.new.bike</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Backend:QueriesSite:Backend:Queries2012-07-01T23:28:06Z<p>MetrixAdmin: </p>
<hr />
<div>Listed below is detailed information on what queries are available and what type of data they provide. The queries listed on this page are considered core queries. Information on how to develop your own backend queries is available on the [[Site:Integration|Integration]] page.<br />
<br />
== Account Content ==<br />
<br />
This context gives us access to content that belongs to accounts.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== User Content ==<br />
<br />
This context gives us access to content that belongs to users.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== All Content ==<br />
<br />
This context gives us access to all content within the entire system.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== My Pay-To-Own Content ==<br />
<br />
This context gives us access to the content this authenticated user owns.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Account Profiles ==<br />
<br />
This context gives us access to the account profiles.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Account|items]]<br />
:This is a list of accounts.<br />
<br />
== User Profiles ==<br />
<br />
This context gives us access to the user profiles.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#User|items]]<br />
:This is a list of users.<br />
<br />
== Personal ==<br />
== Comments ==<br />
== Messages ==<br />
== Location ==<br />
== Activity ==<br />
== Transactions ==<br />
== My Pay-Per-Minute History ==<br />
== My Pay-To-Own History ==<br />
== My Gifts ==<br />
== Profile's Gifts ==<br />
== My Favorite Content ==<br />
<br />
This context gives us access to content favorited by the authenticated viewer.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== My Favorite Users ==<br />
== My Favorite Accounts ==<br />
== Profile's Favorite Users ==<br />
== Profile's Favorite Accounts ==<br />
== Content of My Favorite Users ==<br />
<br />
This context gives us access to content that belongs to the authenticated viewer's favorite users.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Content of My Favorite Accounts ==<br />
<br />
This context gives us access to content that belongs to authenticated viewer's favorite accounts.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Deciding Users ==<br />
== My Dropbox ==<br />
== Profile's Dropbox ==<br />
== My Profit Summary ==<br />
== My Gift Profits ==<br />
== Profile's Gift Profits ==<br />
== My Pay-Per-Min Profits ==<br />
== My Pay-To-Own Profits<br />
== Users, who bought form you ==<br />
== Users, who sold to you ==<br />
== Users, who transacted with you ==<br />
== Shopping Cart ==<br />
== Checkout ==<br />
== Agreements ==</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Site:Backend:QueriesSite:Backend:Queries2012-07-01T23:27:54Z<p>MetrixAdmin: </p>
<hr />
<div>Listed below is detailed information on what queris are available and what type of data they provide. The queries listed on this page are considered core queries. Information on how to develop your own backend queries is available on the [[Site:Integration|Integration]] page.<br />
<br />
== Account Content ==<br />
<br />
This context gives us access to content that belongs to accounts.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== User Content ==<br />
<br />
This context gives us access to content that belongs to users.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== All Content ==<br />
<br />
This context gives us access to all content within the entire system.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== My Pay-To-Own Content ==<br />
<br />
This context gives us access to the content this authenticated user owns.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Account Profiles ==<br />
<br />
This context gives us access to the account profiles.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Account|items]]<br />
:This is a list of accounts.<br />
<br />
== User Profiles ==<br />
<br />
This context gives us access to the user profiles.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#User|items]]<br />
:This is a list of users.<br />
<br />
== Personal ==<br />
== Comments ==<br />
== Messages ==<br />
== Location ==<br />
== Activity ==<br />
== Transactions ==<br />
== My Pay-Per-Minute History ==<br />
== My Pay-To-Own History ==<br />
== My Gifts ==<br />
== Profile's Gifts ==<br />
== My Favorite Content ==<br />
<br />
This context gives us access to content favorited by the authenticated viewer.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== My Favorite Users ==<br />
== My Favorite Accounts ==<br />
== Profile's Favorite Users ==<br />
== Profile's Favorite Accounts ==<br />
== Content of My Favorite Users ==<br />
<br />
This context gives us access to content that belongs to the authenticated viewer's favorite users.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Content of My Favorite Accounts ==<br />
<br />
This context gives us access to content that belongs to authenticated viewer's favorite accounts.<br />
<br />
;itemsTotal<br />
:This is the total number of items belonging to this context.<br />
;offset<br />
:This is the current offset into this context.<br />
;itemsReceived<br />
:This is the number of items actually received from this context.<br />
;limit<br />
:This is the number of items requested for this context.<br />
;pageTotal<br />
:This is the number of pages required to view all objects within this context using the limit amount.<br />
;page<br />
:This is the current page of this context.<br />
;[[Site:HDFObjects#Content|items]]<br />
:This is a list of content objects.<br />
<br />
== Deciding Users ==<br />
== My Dropbox ==<br />
== Profile's Dropbox ==<br />
== My Profit Summary ==<br />
== My Gift Profits ==<br />
== Profile's Gift Profits ==<br />
== My Pay-Per-Min Profits ==<br />
== My Pay-To-Own Profits<br />
== Users, who bought form you ==<br />
== Users, who sold to you ==<br />
== Users, who transacted with you ==<br />
== Shopping Cart ==<br />
== Checkout ==<br />
== Agreements ==</div>MetrixAdminhttp://dev.metrixstream.com/wiki/Main_PageMain Page2012-07-01T23:23:18Z<p>MetrixAdmin: /* Site Backend */</p>
<hr />
<div>Welcome to the Metrixstream development wiki. This guide is intended for a technical audience and will provide detailed information on how interact with Metrixstream and fine tune the user experience to your viewers.<br />
<br />
As always you can email [mailto:support@metrixstream.com support@metrixstream.com] with any of your questions.<br />
<br />
= Site Frontend =<br />
<br />
; [[Site:Frontend:Introduction|Introduction]]<br />
: Everything you need to know to get started making sites.<br />
; [[Site:Frontend:BuildingBlocks|Building Blocks]]<br />
: Learn about the tools at your disposal to build your website.<br />
; [[Site:Frontend:Organization|Organization]]<br />
: Learn how to organize your objects and feature them in the appropriate places.<br />
; [[Site:Frontend:URLParameters|URL Parameters]]<br />
: Learn how to manipulate a webpage via the URL.<br />
; [[Site:Frontend:Faceted Search|Faceted Search]]<br />
: Performing complex searches to find content and profiles.<br />
; [[Site:Frontend:BackendContexts|Backend Contexts]]<br />
: Allows you to request information from the backend.<br />
; [[Site:Frontend:HDFObjects|HDF Objects]]<br />
: Various objects and what information they contain.<br />
; [[Site:Frontend:InternalMacros|Internal Macros]]<br />
: Pre-existing macros provided to help with common tasks.<br />
; [[Site:Frontend:SEOFriendlyURLS|SEO Friendly URLS]]<br />
: Learn how to make SEO friendly URLS.<br />
; [[Site:Frontend:BestPractices|Best Practices]]<br />
: Some simple guidelines on how to make your development easier.<br />
; [[Site:Frontend:Controllers|Controllers]]<br />
: Properly manage all of your functionality across the entire site.<br />
; [[Site:Frontend:Forms|Forms]]<br />
: Different method for how to collect information from the viewer.<br />
; [[Site:Frontend:Macros|Macros]]<br />
: Create macros for common functionality.<br />
; [[Site:Frontend:Modules|Modules]]<br />
: Package a feature in its entirety within the module framework.<br />
<br />
= Site Backend =<br />
<br />
The backend is responsible for executing queries to the database and returning their result in a format the frontend is capable of understanding.<br />
<br />
; [[Site:Backend:Queries|Backend Queries]]<br />
: A list of the supplied backend queries.<br />
<br />
= Site API =<br />
<br />
The API allows modifications to objects through the backend.<br />
<br />
; [[Site:API:Authentication|Authentication]]<br />
: this includes support for login, signup, and logout functionality.<br />
; [[Site:API:Blocks|Blocks]]<br />
: this includes support for adding, editing, and deleting blocks. Blocks allow users to prevent other users from viewing certain objects.<br />
; [[Site:API:Comments|Comments]]<br />
: this includes support for adding, editing, and deleting comments.<br />
; [[Site:API:Content|Content]]<br />
: this includes support for adding, editing, and deleting content.<br />
; [[Site:API:Forums|Forums]]<br />
: this includes support for adding, editing, and deleting forums, threads, and replies.<br />
; [[Site:API:Moderate|Moderate]]<br />
: this includes support for what functionality is available to moderators.<br />
; [[Site:API:PCR|Property Change Requests]]<br />
: this includes support for property changes to objects that require approval by an administrator before they go live.<br />
; [[Site:API:Users|Users]]<br />
: this includes support for adding and editing users.<br />
; [[Site:API:Wysiwyg|Wysiwyg Editor]]<br />
: this includes support for retrieving the built in Wysiwyg Editor.<br />
<br />
= Background Tasks =<br />
<br />
Metrixstream has a background task manager that is capable of executing tasks at certain intervals. This can be useful for backing up the database, syncing content from one server to another, processing log files, etc.<br />
<br />
More information is available on the [[Site:Integration|Integration]] page for those of you who want to create your own tasks.<br />
<br />
= Media Player =<br />
<br />
The Metrixstream media player allows complete customization of the viewing experience. There are several skins available to customize the look and feel of the player. There is also a JavaScript interface that lets you control and manipulate the functionality of the player without having to edit any of the core framework.<br />
<br />
; [[MediaPlayer:Macros|Macros]]<br />
: Learn how to place a media player within a webpage.<br />
; [[MediaPlayer:API:Calls|API Calls]]<br />
: The functions available to control the media player.<br />
; [[MediaPlayer:API:Callbacks|API Callbacks]]<br />
: The callbacks that can be registered to intercept certain actions done via the media player.<br />
; [[MediaPlayer:LiveEvents|Live Events]]<br />
: A list of all events available during a live event and how to interact with them.<br />
; [[MediaPlayer:Skins|Skins]]<br />
: A list of available skins for the media player.<br />
; [[MediaPlayer:WMODE|WMODE]]<br />
: An important mode to understand that can effect the media player performance.<br />
<br />
= Custom Integration =<br />
<br />
All of the above information is to educate you on how the internals of Metrixstream work and how to use what functionality is available to you. Sometimes you may need customization outside the core platform. This section is intended to go a step lower and see how you can end up making your own queries and tasks.<br />
<br />
; [[Site:Interfaces|Interfaces]]<br />
: Interfaces necessary for custom integration.<br />
; [[Site:Integration|Integration]]<br />
: Information on how to integrate directly into the Site Engine by providing your own Backend Contexts.</div>MetrixAdmin