Canvas Studio API documentation

[sor1]

This isn't really a question.  I was trying to get a detailed list of Studio recordings. 

I was finally able to obtain an access token through Postman using this https://community.canvaslms.com/docs/DOC-17723

Then, the after searching, this is the best (only) documentation I was able to find:

https://developerdocs.instructure.com/services/instructure-media/studio-api

I finally figured out that one needs to use the /api/public/media/search call to retrieve the list of recordings.  Also note that the results return a media and a meta section.  The meta area lists the current_page,  last_page and number of recordings.    So one needs to cycle through the pages (/api/public/media/search&page=x) to retrieve everything.   

[James]

Thanks for that link. The place the documentation refers people to is currently broken. It was better organized, but details on how to use it were lacking.

Search seems overly broad -- or maybe just slower than other more focused requests. The thing with Canvas Studio is that I have to limit my requests to about 1 per second or I hit the rate limiting, so slower is a relative term that may not apply here.

I typically only get the media for a single user. For that, I use Get a list of media the user has access to. Note that {user_id} is the Studio user_id, not the Canvas User ID. I still have to use pagination.

When I want a more focused list, I use the List all collections the authenticated user has permission to and then filter to just the collection I want. Then I List media in a specific collection. I use this to gather view data for just one of my classes.

On the other hand, the search is more powerful, allowing you to filter by owner (as opposed to just having access) and whether it was an upload vs YouTube video. I do the filtering on those after downloading the information