(Deprecated) Custom Analytics: Tags

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

Warning: The v2 Analytics API has been deprecated. See Ooyala IQ Analytics for more details on the new v3 Analytics API.

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 
}

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"
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

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"
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

This example deletes a tag:

[DELETE]/v2/analytics/tags/free_customer
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

Was this article helpful?