Custom Analytics: Tags

Tags enable you to inject custom information into Ooyala analytics that you can use to create custom reports.

Create a Tag

To create a new tag:

[PUT] /v2/analytics/tags/tag_id 
{
  properties 
}   
   

List Tags

To list all the tags in your account:

[GET] /v2/analytics/tags
   

Get Tag

To get information about a specific tag:

[GET] /v2/analytics/tags/tag_id 
   

Delete Tag

To permanently delete a tag:

[DELETE] /v2/analytics/tags/tag_id 
   

Update Tag

To update a tag:

[PATCH] /v2/analytics/tags/tag_id 
{
  properties 
}  
   

Route Attributes

The following table describes all attributes that can be expressed through the route.

Route Attribute Description
tag_id

The ID of the tag.

Type: String

Default: None

Example: /analytics/tags/extreme_couch_potato

Properties

The following table describes all properties that can be associated with a syndication.

Property Description Required?
display_name

The name that will appear in reports.

Type: String.

Default: None.

Constraints: Less than 255 characters.

Conditions: Required for create operations.

Example: "18 to 24 Year Olds".

Conditional
tag

ID of the tag.

Type: String.

Default: None.

Constraints: Less than 8 alphanumeric characters, cannot contain spaces.

Conditions: Required for create and delete operations.

Example: "18to24".

Conditional

Examples

This example creates a tag with the name premium_customer:

[PUT] /v2/analytics/tags/premium_customer
{
  "display_name" : "Premium Customers"
}   
    

and returns this response:

{
  "display_name" : "Premium Customers"
}   
    

Sorting Try it

This example modifies a tag:

[PATCH] /v2/analytics/tags/premium_customer
{
  "tag" : "super_premium_customer"
  "display_name" : "Super Premium Customers"
}   
    

and returns this response:

{
  "tag" : "super_premium_customer"
  "display_name" : "Super Premium Customers"
}  
    

Sorting Try it

This example deletes a tag:

[DELETE] /v2/analytics/tags/free_customer
    

Sorting Try it