How to use API to generate a list of users subscribed to a channel

  1. Open the API console at https://developer.kaltura.com/console/ (Sign In) or  http://www.kaltura.com/api_v3/testme.
    If Testme Console is used, first, you will need to generate a KS session as demonstrated on How to Start a Kaltura Session using the TestMe Console
  2. Paste the generated Kaltura Session in the "Kaltura API session (string):" field.
  3. Select session service: categoryUser
  4. Select action: list
  5. Select filter (KalturaCategoryUserFilter):  Edit
    5.1. Set categoryIdEqual (int): input the channel's ID (category ID)
    5.2. Set permissionNamesMatchAnd (string): CATEGORY_SUBSCRIBE
  6. Click Send.
  7. (Optional) In case you have more than 500 results, additional action is needed:
    7.1. Select pager (KalturaFilterPager): Edit 
    7.2. Set pageSize : 500
    7.3. Set pageIndex: 1
    7.4. Click Send
  • Action No.7 will output a list of up to 500 items on the page. When the 'total count' is higher than 500, items 501-1000 can be retrieved by setting 'pageIndex' =2 and 'pageSize' = 500.  Items 1001-1500 can be retrieved using 'pageSize=500' and 'pageIndex=3'. Increment PageIndex and repeat this step as needed.

The list will be generated in XML format and may be exported to Microsoft Excel by the following steps:
1. Copy the result you received from the server to text editor software, such as Notepad++.


2. Save the file as an XML (extension .XML)
3. Open the file using Excel.


For additional details, refer to How to convert an XML Document to CSV File or Excel Spreadsheet.

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In This Article
Related Articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter